The project contains two folders:
- Client - Front-end
- Server - Backend
The server side represents the Back-end part which is built with Node.js and Express.
Please make sure you have the following services installed on your local machine:
In order to start working with our project you need to follow these steps:
- Navigate to the server folder with your preffered CLI.
- Log in into your local mysql database using your preffered CLI.
- Log in with
mysql -u yourUsernameHere -p
- Create a database for the current project by running
CREATE DATABASE yourDBname;
- run
exit;
- Log in with
- Navigate to /server/config and create a file called "db_credentials.js" and follow the template from the "db_credentials_template.js" by inserting the previously set database name, your username and password.
- My platform also includes sending emails with Gmail. Please follow these steps.
- Create a dummy gmail account and set the Less Secure option to be true.
- Navigate to /server/config and create a file called "smtp_credentials.js" and follow the template from the "smtp_credentials_template.js" by inserting your gmail account credentials. This represent the email you will send the emails from when the users will use the Reset Password feature of the app.
- Navigate to back /server and run
npm install
. - After everything is installed, make sure you are in /server folder and run the following commands:
- Migrations:
npm run m:latest
or if you want to rollback the migrationsnpm run m:rollback
- Seeds:
npm run s:run
- Migrations:
- After everything is done you can run
npm run start-dev
in order to start the development server. You should see in console something similar toServer is listening on port 9090 ...
The client side represents the Front-end part which is built with React.
In order to start working with our project you need to follow these steps:
- Navigate to the /client folder with your preffered CLI.
- Run
npm install
- Run
npm run start
A new browser window should pop-up where you can see the project.