CLASS Frontend

Getting Setup

If you've never used github before set your ssh key

1. Clone the repo using git: git clone https://github.com/NJIT-CLASS/frontend.git.
2. Clone the backend repo using git: git clone https://github.com/NJIT-CLASS/backend.git.
3. Set up a local MySQL database and run the latest sql import script
4. Download and install redis
5. Import latest language strings into server using language-import.js to import them to your local redis instance
6. Set the environment variables dbHost, dbUser, dbPass, database, and serverPort or set them in the backend_settings.js to match your MySQL database hostname (probably localhost), database user, database user password, database name, and the port your want the backend server to serve on.
7. Run npm install gulp in the frontend directory
8. Run gulp generate:fallback-settings to generate your fallback settings (just answer the questions)
9. Set the API_URL settings in /server/utils/react_constants.js
10. Run npm install which will install all the third-party packages the project depends on in both the frontend and backend directories.
    • Windows users may need to follow this guide to get argon2 to work in the backend.
11. Run npm start in the frontend directory to start the server and start developing.
12. Run npm start in the backend directory.

Technologies and Tools

• JavaScript
• Node.js
• Express.js: web server framework
• React.js: frontend framework
• Handlebars.js: templating engine
• SCSS: CSS preprocessor
• Redis: Redis

Github Setup

1. Create an SSH key. Run ssh-keygen -t rsa -b 4096 -C "[email protected]"
2. Add the new SSH key to Github

Git Quickstart

Here are the git commands that you can use to get by for now (if you don't know how to use it)

When you want to send your code to GitHub. Then these three commands will get you by for now.

• git add -A will stage all the files you changed so that you can commit them (next command).
• git commit -m 'summary of what you changed' will save the changes.
• git pull origin master will get the latest changes from GitHub (Do this AFTER you commit).
• git push origin master will send your changes to GitHub.