Updated README.md
This commit is contained in:
1 parent
b01c279866
commit
9c7fd69da5
1 file changed
+7
-5
@@ -2,10 +2,12 @@
|
||||
|
||||
This school project is for my teacher to have students log in and check out their XP and assignments.
|
||||
This website application is not available online, this is just a locally run website at our school.
|
||||
To create a teacher, it must be done by a site admin.
|
||||
|
||||
You'll need to create the site admin in the database in a collection called users,
|
||||
and insert a document via MongoDB Compass. Format the document as shown:
|
||||
If you'd like to use this yourself, you'll need to create a teacher, it must be done by a site admin.
|
||||
|
||||
There is no default site admin so you will need to set one up.
|
||||
To set up a site admin, you'll need to create the site admin in the database in a collection called users,
|
||||
and insert a document via MongoDB Compass. Format the document as shown:
|
||||
`{
|
||||
"role": "Admin",
|
||||
"name": your name,
|
||||
@@ -23,7 +25,7 @@ The ID for your admin document should be auto generated by MongoDB Compass when
|
||||
1. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
|
||||
|
||||
### Getting Started with Code :
|
||||
1. Set up MongoDB on your computer.
|
||||
1. Set up [MongoDB](#Setting-up-MognoDB) on your computer.
|
||||
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.
|
||||
@@ -31,7 +33,7 @@ The ID for your admin document should be auto generated by MongoDB Compass when
|
||||
1. Go to http://localhost:8080. Or Whatever you set it to in the `.env` file.
|
||||
|
||||
### Setting up MongoDB
|
||||
1. Install mongodb and follow the setup steps.
|
||||
1. Install mongodb and follow the setup steps.
|
||||
1. [Step by step instructions](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows)
|
||||
|
||||
### Accessing the Database
|
||||
|
||||
Reference in new issue
Block a user