Deployed Version

Live demo (Feel free to visit) 👉 : https://dev-api-campers.herokuapp.com

API Usage

Check DevCampers API Documentation for more info.

Deployment

The website is deployed with git into heroku. Below are the steps taken:

git init
git add -A
git commit -m "Commit message"
heroku login
heroku create
heroku config:set CONFIG_KEY=CONFIG_VALUE
git push heroku master
heroku open

Installation

You can fork the app or you can git-clone the app into your local machine. Once done that, please install all the dependencies by running

$ npm i
$ npm start

Build With

Node.js - JS runtime environment
VSCode - Free source-code editor made by Microsoft
Express - The web framework used
Mongoose - Object Data Modelling (ODM) library
MongoDB Atlas - Cloud database service
Postman - API testing
Git - Open source distributed version control system
MailTrap - Email delivery platform
MapQuest Dev API - Free online web mapping service
Heroku - Cloud platform

NPM Packages

Demonstration

1) Bootcamps

List all bootcamps in the database
- Pagination
- Select specific fields in result
- Limit number of results
- Filter by fields
Search bootcamps by radius from zipcode
- Use a geocoder to get exact location and coords from a single address field
Get single bootcamp
Create new bootcamp
- Authenticated users only
- Must have the role "publisher" or "admin"
- Only one bootcamp per publisher (admins can create more)
- Field validation via Mongoose
Upload a photo for bootcamp
- Owner only
- Photo will be uploaded to local filesystem
Update bootcamps
- Owner only
- Validation on update
Delete Bootcamp
- Owner only
Calculate the average cost of all courses for a bootcamp
Calculate the average rating from the reviews for a bootcamp

2) Courses

List all courses for bootcamp
List all courses in general
- Pagination, filtering, etc
Get single course
Create new course
- Authenticated users only
- Must have the role "publisher" or "admin"
- Only the owner or an admin can create a course for a bootcamp
- Publishers can create multiple courses
Update course
- Owner only
Delete course
- Owner only

3) Reviews

List all reviews for a bootcamp
List all reviews in general
- Pagination, filtering, etc
Get a single review
Create a review
- Authenticated users only
- Must have the role "user" or "admin" (no publishers)
Update review
- Owner only
Delete review
- Owner only

4) Users & Authentication

Authentication will be ton using JWT/cookies
- JWT and cookie should expire in 30 days
User registration
- Register as a "user" or "publisher"
- Once registered, a token will be sent along with a cookie (token = xxx)
- Passwords must be hashed
User login
- User can login with email and password
- Plain text password will compare with stored hashed password
- Once logged in, a token will be sent along with a cookie (token = xxx)
User logout
- Cookie will be sent to set token = none
Get user
- Route to get the currently logged in user (via token)
Password reset (lost password)
- User can request to reset password
- A hashed token will be emailed to the users registered email address
- A put request can be made to the generated url to reset password
- The token will expire after 10 minutes
Update user info
- Authenticated user only
- Separate route to update password
User CRUD
- Admin only
Users can only be made admin by updating the database field manually

Future Updates

Create Front-End design for the api
Improve authentication and authorization
And More ! There's always room for improvement!

Known Bugs

Feel free to email me at [email protected] if you run into any issues or have questions, ideas or concerns. Please enjoy and feel free to share your opinion, constructive criticism, or comments about my work. Thank you! 🙂

Acknowledgement

This project is part of the online course I've taken at Udemy. Thanks to Brad Traversy for creating this awesome course! Link to the course: Node.js API Masterclass With Express & MongoDB