- Alan Bauer
- Ethan Bowers
- Tristan Oshier
- Drew Thomas
- Install MAMP or XAMPP
- Move the project to the htdocs folder of MAMP or XAMPP
- Start your apache server and mysql server
- Open up phpmyadmin and create a new database
book_renew
- Open book_renew_backend as the root directory in a new project in Intellij
- Install the maven dependencies
- Set the correct values for your installation in application.properties located in src/main/java/resources
- As JWTs are used for authentication, the real secret key may need to be updated in src/java/com/bookrenew/api/security/SecurityConstants as it could be compromised if it's in version control
- To run the tests, port 8080 must be open, run the Application (ApiApplication in src/main/java/com/bookrenew/api)
- After this is running the tests should work and will recompile your code
For more help see the HELP.md file located in the backend directory
- Install Node.js and NPM.
- Open up the terminal and
cd
into the client directory. - Run
npm install && npm start
(PC users will see SKIPPING OPTIONAL DEPENDENCY: fsevents. This dependency is for Mac users). - This should open up the project on localhost port 3000
- You may have to edit the config file located in client/src/config
For more help see the README.md in the client directory
- Start your apache and mysql server
- If one of the tables in the database has changed since last running the backend you must either make the change manually or drop the table in the database
- Run ApiApplication in src/main/java/com/bookrenew/api to start the tomcat server/backend. You may need to open the backend separately in Intellij for this to work. (until this is done the unit tests won't run correctly)
cd
into the client directory and runnpm install && npm start
- The entities in the backend suppress unused because Spring will call the functions dynamically behind the scenes so an IDE won't recognize them as being used.