Welcome to Dinos Marketplace 🦖! This README.md file provides you with instructions on how to set up, run, and access the application, as well as an overview of the project's design.
Follow the instructions below to set up and run the application on your local machine.
- Clone the repository:
git clone https://github.com/arrushigupta/SENG401-FinalProject.git- Installation & Run the application:
How to run it locally:
run
cd Client
npm install
npm startcreate sendgrid.env file in the Server folder, then put
export SENDGRID_API_KEY='{YOUR_API_KEY}'in the sendgrid.env file.
run
cd Server
npm install
sh run.sh- Data privacy: Data is kept private by encrypting sensitive user information
- Ease of use: The application is very easy to use, with an intuitive GUI and helpful text prompts throughout the application. The app requires minimal training, so anyone can use it.
- Aesthetic: GUI interface was designed using tailwind, which is a css library specific to the React frontend framework. This allowed for components with similar elements throughout the application
- Accessibility: our application can be accessed from anywhere in the world, with minimal downtime. This is possible since we are hosting our database and server on the cloud.
- Two factor authentication: Email verification in order to ensure users are creating accounts with their own emails, and users are who they say they are.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.