https://github.com/john-pels/bootcamp-api

REST API for Web Application, which is a bootcamp directory website with Admin routes.
https://github.com/john-pels/bootcamp-api

database expressjs geolocation mapquest mongodb mongoose nodejs rest-api

Last synced: 2 months ago
JSON representation

REST API for Web Application, which is a bootcamp directory website with Admin routes.

• Host: GitHub
• URL: https://github.com/john-pels/bootcamp-api
• Owner: John-pels
• License: mit
• Created: 2024-04-30T05:37:43.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T14:27:16.000Z (6 months ago)
• Last Synced: 2024-07-19T16:54:48.927Z (6 months ago)
• Topics: database, expressjs, geolocation, mapquest, mongodb, mongoose, nodejs, rest-api
• Language: JavaScript
• Homepage:
• Size: 330 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![GitHub issues](https://img.shields.io/github/issues/john-pels/devcamper-api.svg)](https://github.com/john-pels/devcamper-api/issues)

[![GitHub last commit](https://img.shields.io/github/last-commit/john-pels/devcamper-api.svg)](https://github.com/bamiogunfemi/react-redux-boilerplate/commits/master)

[![Analytics](https://ga-beacon.appspot.com/UA-83446952-1/github.com/john-pels/devcamper-api/README.md)](https://github.com/john-pels/devcamper-api/)

![Image](./public/uploads/photo_5d725a1b7b292f5f8ceff788.jpg)

# Bootcamp-api

> Backend API for Bootcamp Web Application, which is a bootcamp directory website

## Dependencies

In order to run this server, you need to have installed the following dependencies:

1.  Node - min v8.15.0

2.  NPM - min v5.6.0

    or

3.  Yarn - min v1.3.2

4.  Bash terminal (Default on OSX/Linux, GitBash or similar on Windows)

## Details

### JS

Folder structure:

- `_data/` - default seed data

- `config/` - database configuration and environment variables

- `controllers/` - abstraction controller layer

- `middleware/` - error handling middleware, authentication middleware, logger, and pagination

- `models/` - database schema configuration

- `public/` - documentation web page

- `routes/` - API routes

- `utils/` - utility and helper functions

## Usage

Rename "config/config.env.env" to "config/config.env" and update the settings to your own

## Install dependencies

```

npm instal

```

## Run App

```

# Run in dev mode

npm run dev

# Run in production mode

npm start

```

- Version: 1.0.0

- License: MIT