EARNILY

Welcome to the Earnily API, this API is for developers looking for the right API to develop their Job seeking / Employment platform

Table of Contents

1. Features
2. Installation
3. Endpoints
4. Technologies
5. Usage
6. Testing
7. API Documentation
8. Author
9. License

Features

• Create a job (For employers)
• Get all jobs
• Get a single job
• Update a job
• Delete a job
• apply for a job (for jobseekers)
• update status of a particular job application (for employers)

Installation

Please follow this guide carefully on how to install the Earnily API on your local machine

1. clone the repository: I will recommend to use a CLI for this operation instead of a GUI. For this operation I will be using bash.

   git clone https://github.com/ezeisraeljohn/earnily.git
   cd earnily

2. Install dependencies: To install the dependencies, you need to run the following command

   npm install

3. Environment Variables: Create a .env file in the root directory of the project and add the following environment variables

   SECRET=your_secret_key
   PORT=3000
   Test_MONGO_URI=mongodb://localhost:27017/earnily  # serves and the database for your main application
   T_Mongo_URI=mongodb://localhost:27017/test_earnily # serves as the database for your test

4. start the server: To start the server, you need to run the following command

   npm start

Endpoints

below are the sneek peek of the endpoints

• POST /api/v1/register - Register a user
• POST /api/v1/login - Login a user
• POST /api/vi/jobs - Create a job
• POST /api/v1/jobs/:jobId/apply - Apply for a job

see the full documentation at API Documentation

Technologies

• Node.js
• Express
• MongoDB
• Azure Blob Storage

Usage

once you have the server running, you can interact wit the api using tools like Postman, Insomnia, or curl

Testing

You can test the API endpoints using Postman. Import the collection directly using the following link:

Or you can run the test using the following command

npm test

API Documentation

For detailed API documentation, visit the Postman endpoints.

Author

• Eze Israel John

License

This project is licensed under the MIT License. See the LICENSE file for details.