VPCI-Student-Services

Requirements

• Node.js - (https://nodejs.org/en/download)
• Postgres - (https://postgresapp.com/) <- macOS link, for Windows, search up a tutorial...

Setup and Run

• git clone <link> to clone the repo get the link from the green Code button above.

Assuming you also have Node.js installed,

• npm install to download all the dependencies.

Assuming you have Postgres installed,

1. npx sequelize init to create the config folder, (DO NOT USE --force)
2. then run createuser <username>
3. then run createdb <database-name> -O <username>
4. In config/database.json, change "username" to the username used in the above commands.
5. Change "database" to the name you gave to the database.
6. Change "dialect" to "postgres"
7. The models are already made, run npx sequelize db:migrate which will translate the migrations into tables in the database
8. run npx sequelize db:seed:all to add the dummy data (this won't overwrite anything, it'll only add data). npx sequelize db:seed:undo:all to undo. Read the txt file in database/ for more information.

Now that the database works,

1. npm run build to bundle the javascript and HTML. (Don't touch the build folder)
2. npm start to start the application.
3. Visit localhost in your browser.

When making changes to the backend, restart the server for them to work.

How it works

Accounts

Account creation can only be done through a link sent to an exec of a club or a staff member. Users are not encouraged to share accounts.

Clubs and Accounts

Users will create clubs and be able to edit them from the account dashboard. Other users can be allowed to edit clubs by anyone who has those permissions. Users can remove themselves from clubs and admin accounts (staff).

Posts and Accounts

Posts are tied to clubs and any account which has access to a club can edit its posts.

Events and Accounts

Events are also tied to clubs and any account which has access to the club and edit its events. Events will show up on the event calendar on the home page. There will also be events that are related to the school and those will be made by admin accounts (staff).