- Notifications
You must be signed in to change notification settings - Fork0
A self hosted MERN quiz app for making learning fun and effective
License
Devorein/Qocean
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A self hosted MERN quiz app for making learning fun and effective.
Since its self hosted you'll host the app on your own server aka localhost and your own database, so that none can view your credentials and private data, but it needs a bit more effort from you to work.
- Node
- NPM
- Clone or download the experiment branch. It always has the latest commits.
- Navigate to the client folder and install the dependencies by running
npm i
. - In the public folder create another folder named
uploads
, this is where all the uploaded files will be stored. - Navigate to the server folder and install its dependencies by running
npm i
. - Inside config folder create a file named config.env (its required as it contains all the configuration info for the app).
- Create a mongodb atlas account and cloud cluster, and provide the url to the config.env file.
- To start both the client and the server navigate to the respective directory and run
npm start
MERN app for making killer quiz to enhance learning
Since its self hosted you'll host the app on your own server aka localhost and your own database, so that none can view your credentials and private data, but it needs a bit more effort from you to work.
Make sure your configuration file have the following key and value pairs separated by =
PORT
=any valid port
NODE_ENV
=development|production|testing
MONGO_URI
=mongodb atlas cluster url
FILE_UPLOAD_SIZE
=max file upload size in bytes
JWT_SECRET
=any strong password
JWT_EXPIRE
=see jwt documentation for more info, tldr; useday_number
d to specify how many days the token will last
JWT_COOKIE_EXPIRE
=same asJWT_EXPIRE
without the d
Take a look at thisfile to see all the available features of the app and the api.
Take a look at thisfile to understand the rest api structure.
To generate a static graphql documentation, installgraphqhdoc
, navigate to the server dir and rungraphdoc