Skip to content

Yazan-Ali-01/Developers-Camp-Api

Repository files navigation


Development Bootcamps API

Development Bootcamps API made with Node.JS and Express with a lot of routes and methods
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Contact

About The Project

APIs are vital tools for businesses in all industries. The importance of APIs from a technical standpoint, they allow the capabilities of one computer program to be used by another. They are a means by which two different programs are able to communicate.

Here's why:

  • APIs are needed to bring applications together in order to perform a designed function built around sharing data and executing pre-defined processes
  • It helps me ,As a full stack developer, separate different concerns, especially between front and back ends
  • Having the ability to extend the application on a variety of platforms is a great advantage of using APIS

(back to top)

Built With

  • NodeJS
  • Express.js
  • MongoDB
  • https://img.shields.io/badge/Database-Mongoose-blue
  • https://img.shields.io/badge/other-express--session-yellow
  • https://img.shields.io/badge/other-flash-lightgrey
  • https://img.shields.io/badge/other-csrf-orange

(back to top)

Getting Started

To get started clone the repository and read the installation instructions below

Prerequisites

list of things you need to use the software

  • npm
    npm install npm@latest -g
  • MongoDB installed locally on your PC

Installation

_Below is an example of how you can install and set up the app locally.

  1. Clone the repo

    git clone https://github.com/Yazan-Ali-01/Developers-Camp-Api.git
  2. Install NPM packages

    npm install
  3. Enter your environment variables in .env.example then change its name to .env only

  4. start MongoDB local database server in your terminal with

    mongod
  5. start application with npm run dev in the terminal

  6. Test it with the API tool you want (PostMan is preferred)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Email: [email protected]

Project Link: https://github.com/Yazan-Ali-01/Developers-Camp-Api

(back to top)

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published