Everyone working on this Repository please follow the below rules:

1. Fork the repo on your github to work on it
2. Once you are dev complete, you can raise a pull request to organization repo
3. You need 2 reviewers to review your pull request before it can me merged to master branch of the Organization Repo
4. I have added gitignore for VS code. If you are using any other code editor add appropriate git ignore
5. Basic Folder Structure has been added to the project. Please follow the same for your development

│   package.json                                # Has all the dependencies needed to run the application
│   server.js                                   # The main Server file that runs the application
│
└───src                                         # Folder having all the needed routes,controllers and middleware
    │
    ├───CONSTANTS                               # Folder to hold all the Constant files
    │       constants.js                        # File having all the constant values such as status code, responses etc.
    │
    ├───controller                              # Folder with all the controllers that run the required functions for api
    │   │   emailController.js                  # Controller to handle all the email api's
    │   │   jobApplicationController.js         # Controller to handle all the job application api's
    │   │   jobpostingController.js             # Controller to handle all the job posting api's
    │   │   passwordController.js               # Controller to handle all the password reset related api's
    │   │   userController.js                   # Controller to handle all the user related api's
    │   │
    │   └───common_controllers                  # All the controllers that are used across other controllers
    │           addUserController.js            # Controller to handle the add api call for users
    │           loginController.js              # Controller to handle login api for user
    │           postAuthenticationController.js # Controller to handle the user authentication for crud operations for users
    │
    ├───Logger                                  # Folder with the javascript file to handle the logs
    │       logger.js                           # Javascript file handling the logging of data
    │
    ├───middleware                              # Middleware folder for handling common requests between the api's
    │       authenticationMiddleware.js         # Authentication Middleware used for postAuthenticationController.js
    │       emailMiddleware.js                  # Middleware to handle all the email requests.
    │       loginMiddleware.js                  # Middleware to check if user exists and to update the login attempts count
    │       mongooseMiddleware.js               # Middleware to handle all the mongoose queries
    │
    ├───model                                   # Folder having all the mongoose models to be created in mongoDB
    │       jobApplicationModel.js              # Model for job application
    │       jobPostingModel.js                  # Model for posting jobs
    │       userModel.js                        # Model for user
    │
    └───Routes                                  # Folder with all the routes. Used in server.js file
            basicroutes.js                      # Basic routes showing hello page and the count of data for each model
            emailRoutes.js                      # Routes to handle email
            jobApplicationsRoutes.js            # Routes for Job Applications
            jobPostingRoutes.js                 # Routes for Posting jobs
            passwordRoutes.js                   # Routes for password reset and confirmation
            userRoutes.js                       # Routes for Users

1. Clone your forked repository on your local machine using the following command:

   git clone https://github.com/your_github_name/C19_Website.git

2. Once cloned cd into the folder and open the files in your favourite editor.

3. Open a terminal in your folder and run the following command to install all the packages.

   npm i

4. Environment Variables

   This project uses a number of environment variables for configuration. For local development, you will need to create a .env in your root folder with the follwing shape.

   RESEARCHER_PUBLIC_KEY=<researcher-public-key>
   RESEARCHER_PRIVATE_KEY=<researcher-private-key>
   VOLUNTEER_PUBLIC_KEY=<volunteer-public-key>
   VOLUNTEER_PRIVATE_KEY=<volunteer-private-key>
   MONGO_DB_URL_LOCAL=<uri-for-local-db>

   Generating User Keys

   The public keys are RSA keys which will then need to be base64 encoded:

   1. To create the public and private keys go to this RSA key generator website website and create them and place them in the private.key files shown in the file above. Remember to select PKCS #8 (base64) from the dropdown.

   2. Then go this base-64 encoding website and paste in generated RSA key from the step above. The value returned from the website will be the value of the environment variable in the .env file.

   Note: The private and public keys should be different for volunteer and researcher. Do not use the same public and private keys or you will get errors when trying to run the server.

   For example, if you get a public key like the one below which you would like to use for your researcher public key:

   -----BEGIN PUBLIC KEY-----
   MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAL3Tu0OJUvbxpJWCIMq2nEarYFHp7K9D
   sNn/J+Tuad2KBXDDELughSKnoesk9bh05SFbWDX9VI3cDOjB4S/pbCsCAwEAAQ==
   -----END PUBLIC KEY-----
   

   The output after base-64 encoding will be:

   LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUZ3d0RRWUpLb1pJaHZjTkFRRUJCUUFEU3dBd1NBSkJBTDNUdTBPSlV2YnhwSldDSU1xMm5FYXJZRkhwN0s5RApzTm4vSitUdWFkMktCWERERUx1Z2hTS25vZXNrOWJoMDVTRmJXRFg5VkkzY0RPakI0Uy9wYkNzQ0F3RUFBUT09Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==
   

   And your .env file will look like this

   RESEARCHER_PUBLIC_KEY=LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUZ3d0RRWUpLb1pJaHZjTkFRRUJCUUFEU3dBd1NBSkJBTDNUdTBPSlV2YnhwSldDSU1xMm5FYXJZRkhwN0s5RApzTm4vSitUdWFkMktCWERERUx1Z2hTS25vZXNrOWJoMDVTRmJXRFg5VkkzY0RPakI0Uy9wYkNzQ0F3RUFBUT09Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==
   #...

   For typical cases, you can set your MONGO_DB_URL_LOCAL variable like so:

   MONGO_DB_URL_LOCAL=mongodb://localhost:27017/CVD19DEV

5. Once all the packages are installed and folders created run the command below to start the api.

   npm start

6. Make sure you have your mongoDB instance running in the local machine. Run the following command in your local machine
   

   PS: This is temporary as well

   mongod

   Follow the steps in the following link to setup mongo db on your machine: https://treehouse.github.io/installation-guides/windows/mongo-windows.html

   To seed local database with test data, run the following in the root project folder.
   

   npm run seed

   To clear the database of test data, run the following in the root project folder.
   Warning: This will drop the collections in the database

   npm run clear

7. To test if your application running go to http://localhost:3000/. It should give you the count of users, job applications and job postings in the database.

Note: Mandatory here means value that need to be passed from the Front end. There are certain values that are mandatory but need not be passed from the front end and is handled by the api itself.

PS: The userID mentioned here means the auto generated id from mongoDB (_id)

{
"firstName":"FirstName",
"lastName":"LastName",
"email":"your_email",
"gender":"Gender",
"skills":"Web Development,Node JS,MongoDB,PowerBI,Tableau",
"password":"Password1!",
"education":"Masters",
"dateofBirth":"DOB",
"portfolioLink":"LinedIN/portfolio URL",
"type":"Researcher/user"
}

PS: The userid and jobID mentioned here means the auto generated id from mongoDB (_id)

PS: The userID and applicationID mentioned here means the auto generated id from mongoDB (_id)

PS: The userID and applicationID mentioned here means the auto generated id from mongoDB (_id)