willy836/jobs-api

This is a simple Node.js/Express REST API that allows users to manage their job applications efficiently and keep track of the various interviewing stages of the jobs.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Jobs API

Jobs API is a simple Node.js REST API that allows a job seeker to manage their job applications and keep track of the various interviewing stages of the jobs.

🛠 Built With Node.js

Tech Stack

• Node.js
• Express
• MongoDB

Server

• Node's built in server

Database

• MongoDB

Key Features

• User Authentication using JWT
• Managing job applications

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node installed on your computer

Setup

Clone this repository to your desired folder:

• git clone https://github.com/willy836/jobs-api.git
• cd jobs-api/

Install

Install this project with:

• run npm install to install necessary dependencies

Usage

To run the project on your locally, execute the following command:

• npm run start
• On your browser, type http://127.0.0.1:3000 to see the app

(back to top)

👥 Author

👤 Wilson Kimiri

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Feature

• [Add unit tests]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give this project a ⭐️ if you like it.

(back to top)

🙏 Acknowledgments

Hat tip to the awesome Node.js documentation for the guidance and provision of learning materials

(back to top)

📝 License

This project is MIT licensed.

(back to top)