29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# XP-System
|
|
|
|
School Project
|
|
This school project is for my teacher to have students
|
|
log in and check out their XP and assignments.
|
|
|
|
### Requirements :
|
|
1. [Node.js](https://nodejs.org/en/)
|
|
1. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
|
|
|
|
### Getting Started with Code :
|
|
1. [Set Up MongoDB](#setting-up-mongodb) and start mongodb
|
|
2. Clone repo from https://github.com/Braeden57/XP-System.git
|
|
3. Run `npm install` to install dependencies.
|
|
4. Duplicate `.env.example` and rename the new file to `.env`. Edit to your configurations.
|
|
1. Run `npm start` to boot up server.
|
|
1. Go to http://localhost:5000.
|
|
|
|
### Setting up MongoDB
|
|
1. Install mongodb via brew. `brew install mongodb`
|
|
1. Start mongodb via brew. `brew services restart mongodb`
|
|
2. Or Install mongodb compass https://www.mongodb.com/try/download/compass
|
|
|
|
### Accessing the Database
|
|
1. Locally this will use the knoldus db (or whatever you specify manually)
|
|
1. launch mongo via your command-line: `mongo`
|
|
1. Use `show dbs` to see all that are available. You should see `knoldus` in the list.
|
|
1. Lets use that db: `use knoldus`.
|