IEEE Chrome Extension Project

This is a chrome extension that will help you organize your tabs, assignments, and more.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to utilize this project and how to install them

NodeJS (v20.8.0 used) - https://nodejs.org/en/download/current
NPM (v10.4.0 used) - https://nodejs.org/en/download/current
Visual Studio Code (v1.18.6 used) - https://code.visualstudio.com/download
MongoDB Atlas (provided by MongoDB) - https://www.mongodb.com/

Installing

A step by step series of examples that tell you how to get a development env running:

Clone the project (or download it):

git clone https://github.com/Aibaww/IEEE24-Backend.git

Open the root directory in Visual Studio Code

Run the following command in root folder

npm install

Create a .env file in the root directory (ieee-backend) with the following values

PORT=5555
DATABASE_URL=(your mongodb ip, example is mongodb+srv://user:[email protected]/?retryWrites=true&w=majority)
DATABASE_TABLE=ieee

To run the backend

Click on the "Run and Debug" button (left sidebar)

Ensure the dropdown says "Backend Development"

Click the Play button

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system PM2?

Built With

• Node.js - environment
• ExpressJS - web framework used
• Mongo Atlas - database used

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Jason Yue - Initial template - kymotsujason
• Aiba - DevOps, server & db setup Aibaww
• Phatic - Routes programming phatic39

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc