DevCamper API
Backend API for the DevCamper application to manage bootcamps, courses, reviews, users and authentications
Bootcamps
+7
Bootcamps CRUD functionality
Description Fetch all bootcamps from database. Includes pagination, filtering, etc
Description Get single bootcamp by id
Description Add new bootcamp to database. Must be authenticated and must be publisher or admin
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"name": "ModernTech Bootcamp",
+"description": "ModernTech has one goal, and that is to make you a rockstar developer and/or designer with a six figure salary. We teach both development and UI/UX",
+"website": "https://moderntech.com",
+"phone": "(222) 222-2222",
+"email": "enroll@moderntech.com",
+"address": "220 Pawtucket St, Lowell, MA 01854",
+"careers": ["Web Development", "UI/UX", "Mobile Development"],
+"housing": false,
+"jobAssistance": true,
+"jobGuarantee": false,
+"acceptGi": true
+}
Description Update single bootcamp in database
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"careers": [
+"Web Development",
+"UI/UX"
+]
+}
Description Delete bootcamp from database
Description Get bootcamps within a radius of a specific zipcode
Description Rode to upload a bootcamp photo
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"careers": [
+"Web Development",
+"UI/UX"
+]
+}
Courses
+6
Create, read, update and delete courses
Description Get all courses in Database
Description Get the specific courses for a bootcamp
Description Get a single course by its ID
Description Create a course for a specific bootcamp
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"title": "Full Stack Web Development",
+"description": "In this course you will learn full stack web development, first learning all about the frontend with HTML/CSS/JS/Vue and then the backend with Node.js/Express/MongoDB",
+"weeks": 12,
+"tuition": 10000,
+"minimumSkill": "intermediate",
+"scholarhipsAvailable": true
+}
Description Update Course in DB
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"tuition": 13000,
+"minimumSkill": "advanced"
+}
Description Delete course from DB
Authentication
+8
Routes for user authentication including register, login, reset password etc
Description Add user to the database with encrypted password
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"name": "Albert Khomich",
+"email": "albert@gmail.com",
+"password": "123456",
+"role": "publisher"
+}
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"email": "john@gmail.com",
+"password": "123456"
+}
Headers Key Value Description Content-Type application/json JSON Type
Description Generate password token and send email
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"email": "john@gmail.com"
+}
Description Reset user password using token
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"password": "012345"
+}
Description Update logged in user name and email
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"email": "john@gmail.com",
+"name": "John Doe"
+}
Description Update logged in user password, send in the body currentPassword and newPassword
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"currentPassword": "123456",
+"newPassword": "1234567"
+}
Description Clear token cookie
Users
+5
CRUD functionality for users only available to admins
Description Get all users (admin)
Description Get single user by id (admin)
Description Add user to database (admin)
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"name": "Albert Khomich",
+"email": "ak@gmail.com",
+"password": "123456"
+}
Description Update user in database (admin)
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"name": "Albert Khomitch"
+}
Description Delete user from database (admin)
Reviews
+6
Manage course reviews
Description Get all reviews from database and populate with bootcamp name and description
Description Fetch the reviews for a specific bootcamp
Description Fetch a review from database by id and populate Bootcamp name and description
Description Insert review for a specific bootcamp
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"title": "Nice Bootcamp",
+"text": "I learned a lot",
+"rating": 8
+}
Description Update review in database
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"title": "Had Fun"
+}
Description Remove review from database
Headers Key Value Description Content-Type application/json JSON Type
Body {
+"title": "Had Fun"
+}
Generated at 2023-01-21 10:54:10 by docgen
\ No newline at end of file
diff --git a/public/uploads/photo_5d725a1b7b292f5f8ceff788.jpg b/public/uploads/photo_5d725a1b7b292f5f8ceff788.jpg
new file mode 100644
index 0000000..ec510d9
Binary files /dev/null and b/public/uploads/photo_5d725a1b7b292f5f8ceff788.jpg differ
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..10b0ddb
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,26 @@
+# DevCamper API
+
+> Backend API for DevCamper application, which is a bootcamp directory website
+
+## Usage
+
+Rename "config/config.env.env" to "config/config.env" and update the values/settings to your own
+
+## Install Dependencies
+
+```
+npm install
+```
+
+## Run App
+
+```
+# Run in dev mode
+npm run dev
+
+# Run in prod mode
+npm start
+```
+
+- Version 1.0.0
+- Licence MIT
diff --git a/routes/auth.js b/routes/auth.js
new file mode 100644
index 0000000..edf847b
--- /dev/null
+++ b/routes/auth.js
@@ -0,0 +1,26 @@
+const express = require('express');
+const {
+ register,
+ login,
+ logout,
+ getMe,
+ forgotPassword,
+ resetPassword,
+ updateDetails,
+ updatePassword,
+} = require('../controllers/auth');
+
+const router = express.Router();
+
+const { protect } = require('../middleware/auth');
+
+router.post('/register', register);
+router.post('/login', login);
+router.get('/logout', logout);
+router.get('/me', protect, getMe);
+router.put('/updatedetails', protect, updateDetails);
+router.put('/updatepassword', protect, updatePassword);
+router.post('/forgotpassword', forgotPassword);
+router.put('/resetpassword/:resettoken', resetPassword);
+
+module.exports = router;
diff --git a/routes/bootcamps.js b/routes/bootcamps.js
new file mode 100644
index 0000000..9b6ffff
--- /dev/null
+++ b/routes/bootcamps.js
@@ -0,0 +1,44 @@
+const express = require('express');
+const {
+ getBootcamps,
+ getBootcamp,
+ createBootcamp,
+ updateBootcamp,
+ deleteBootcamp,
+ getBootcampsInRadius,
+ bootcampPhotoUpload,
+} = require('../controllers/bootcamps');
+
+const Bootcamp = require('../models/Bootcamp');
+
+//Include other resource routers
+const courseRouter = require('./courses');
+const reviewRouter = require('./reviews');
+
+const router = express.Router();
+
+const advancedResults = require('../middleware/advancedResults');
+const { protect, authorize } = require('../middleware/auth');
+
+//Re-route into other resource routers
+router.use('/:bootcampId/courses', courseRouter);
+router.use('/:bootcampId/reviews', reviewRouter);
+
+router.route('/radius/:zipcode/:distance').get(getBootcampsInRadius);
+
+router
+ .route('/:id/photo')
+ .put(protect, authorize('publisher', 'admin'), bootcampPhotoUpload);
+
+router
+ .route('/')
+ .get(advancedResults(Bootcamp, 'courses'), getBootcamps)
+ .post(protect, authorize('publisher', 'admin'), createBootcamp);
+
+router
+ .route('/:id')
+ .get(getBootcamp)
+ .put(protect, authorize('publisher', 'admin'), updateBootcamp)
+ .delete(protect, authorize('publisher', 'admin'), deleteBootcamp);
+
+module.exports = router;
diff --git a/routes/courses.js b/routes/courses.js
new file mode 100644
index 0000000..b650b6d
--- /dev/null
+++ b/routes/courses.js
@@ -0,0 +1,34 @@
+const express = require('express');
+const {
+ getCourses,
+ getCourse,
+ addCourse,
+ updateCourse,
+ deleteCourse,
+} = require('../controllers/courses');
+
+const Course = require('../models/Course');
+
+const router = express.Router({ mergeParams: true });
+
+const advancedResults = require('../middleware/advancedResults');
+const { protect, authorize } = require('../middleware/auth');
+
+router
+ .route('/')
+ .get(
+ advancedResults(Course, {
+ path: 'bootcamp',
+ select: 'name description',
+ }),
+ getCourses
+ )
+ .post(protect, authorize('publisher', 'admin'), addCourse);
+
+router
+ .route('/:id')
+ .get(getCourse)
+ .put(protect, authorize('publisher', 'admin'), updateCourse)
+ .delete(protect, authorize('publisher', 'admin'), deleteCourse);
+
+module.exports = router;
diff --git a/routes/reviews.js b/routes/reviews.js
new file mode 100644
index 0000000..1a2a67b
--- /dev/null
+++ b/routes/reviews.js
@@ -0,0 +1,34 @@
+const express = require('express');
+const {
+ getReviews,
+ getReview,
+ addReview,
+ updateReview,
+ deleteReview,
+} = require('../controllers/reviews');
+
+const Review = require('../models/Review');
+
+const router = express.Router({ mergeParams: true });
+
+const advancedResults = require('../middleware/advancedResults');
+const { protect, authorize } = require('../middleware/auth');
+
+router
+ .route('/')
+ .get(
+ advancedResults(Review, {
+ path: 'bootcamp',
+ select: 'name description',
+ }),
+ getReviews
+ )
+ .post(protect, authorize('user', 'admin'), addReview);
+
+router
+ .route('/:id')
+ .get(getReview)
+ .put(protect, authorize('user', 'admin'), updateReview)
+ .delete(protect, authorize('user', 'admin'), deleteReview);
+
+module.exports = router;
diff --git a/routes/users.js b/routes/users.js
new file mode 100644
index 0000000..886f660
--- /dev/null
+++ b/routes/users.js
@@ -0,0 +1,24 @@
+const express = require('express');
+const {
+ getUsers,
+ getUser,
+ createUser,
+ updateUser,
+ deleteUser,
+} = require('../controllers/users');
+
+const User = require('../models/User');
+
+const router = express.Router({ mergeParams: true });
+
+const advancedResults = require('../middleware/advancedResults');
+const { protect, authorize } = require('../middleware/auth');
+
+router.use(protect);
+router.use(authorize('admin'));
+
+router.route('/').get(advancedResults(User), getUsers).post(createUser);
+
+router.route('/:id').get(getUser).put(updateUser).delete(deleteUser);
+
+module.exports = router;
diff --git a/seeder.js b/seeder.js
new file mode 100644
index 0000000..d2e08d9
--- /dev/null
+++ b/seeder.js
@@ -0,0 +1,69 @@
+const fs = require('fs');
+const mongoose = require('mongoose');
+const colors = require('colors');
+const dotenv = require('dotenv');
+
+// Load env vars
+dotenv.config({ path: './config/config.env' });
+
+//Load models
+const Bootcamp = require('./models/Bootcamp');
+const Course = require('./models/Course');
+const User = require('./models/User');
+const Review = require('./models/Review');
+
+//Connect to DB
+mongoose.connect(process.env.MONGO_URI, {
+ useNewUrlParser: true,
+});
+
+// Read JSON files
+const bootcamps = JSON.parse(
+ fs.readFileSync(`${__dirname}/_data/bootcamps.json`, 'utf8')
+);
+
+const courses = JSON.parse(
+ fs.readFileSync(`${__dirname}/_data/courses.json`, 'utf8')
+);
+
+const users = JSON.parse(
+ fs.readFileSync(`${__dirname}/_data/users.json`, 'utf8')
+);
+
+const reviews = JSON.parse(
+ fs.readFileSync(`${__dirname}/_data/reviews.json`, 'utf8')
+);
+
+// Import into DB
+const importData = async () => {
+ try {
+ await Bootcamp.create(bootcamps);
+ await Course.create(courses);
+ await Review.create(reviews);
+ await User.create(users);
+ console.log('Data imported...'.green.inverse);
+ process.exit();
+ } catch (err) {
+ console.error(err);
+ }
+};
+
+//Delete data
+const deleteData = async () => {
+ try {
+ await Bootcamp.deleteMany();
+ await Course.deleteMany();
+ await User.deleteMany();
+ await Review.deleteMany();
+ console.log('Data destroyed...'.red.inverse);
+ process.exit();
+ } catch (err) {
+ console.error(err);
+ }
+};
+
+if (process.argv[2] === '-i') {
+ importData();
+} else if (process.argv[2] === '-d') {
+ deleteData();
+}
diff --git a/server.js b/server.js
index 0aa4a2a..22b5f4b 100644
--- a/server.js
+++ b/server.js
@@ -1,14 +1,94 @@
+const path = require('path');
const express = require('express');
const dotenv = require('dotenv');
+const morgan = require('morgan');
+const colors = require('colors');
+const fileupload = require('express-fileupload');
+const cookieParser = require('cookie-parser');
+const mongoSanitize = require('express-mongo-sanitize');
+const helmet = require('helmet');
+const xss = require('xss-clean');
+const rateLimit = require('express-rate-limit');
+const hpp = require('hpp');
+const cors = require('cors');
+const errorHandler = require('./middleware/error');
+const connectDB = require('./config/db');
//Load env vars
dotenv.config({ path: './config/config.env' });
+//Connect to database
+connectDB();
+
+//Route files
+const bootcamps = require('./routes/bootcamps');
+const courses = require('./routes/courses');
+const auth = require('./routes/auth');
+const users = require('./routes/users');
+const reviews = require('./routes/reviews');
+
const app = express();
+//Body parser
+app.use(express.json());
+
+//Cookie parser
+app.use(cookieParser());
+
+// Dev logging middleware
+if (process.env.NODE_ENV === 'development') {
+ app.use(morgan('dev'));
+}
+
+//File uploading
+app.use(fileupload());
+
+// Sanitize data
+app.use(mongoSanitize());
+
+// Set security headers
+app.use(helmet());
+
+// Prevent XSS attacks
+app.use(xss());
+
+// Rate limiting
+const limiter = rateLimit({
+ windowMs: 10 * 60 * 1000,
+ max: 100,
+});
+app.use(limiter);
+
+// Prevent http param pollution
+app.use(hpp());
+
+// Enable CORS
+app.use(cors());
+
+//Set static folder
+app.use(express.static(path.join(__dirname, 'public')));
+
+//Mount routers
+app.use('/api/v1/bootcamps', bootcamps);
+app.use('/api/v1/courses', courses);
+app.use('/api/v1/auth', auth);
+app.use('/api/v1/users', users);
+app.use('/api/v1/reviews', reviews);
+
+app.use(errorHandler);
+
const PORT = process.env.PORT || 5000;
-app.listen(
- PORT,
- console.log(`Server running in ${process.env.NODE_ENV} mode on port ${PORT}`)
-);
\ No newline at end of file
+const server = app.listen(
+ PORT,
+ console.log(
+ `Server running in ${process.env.NODE_ENV} mode on port ${PORT}`.yellow.bold
+ )
+);
+
+//Handle unhandled promise rejections
+process.on('unhandledRejection', (err, promise) => {
+ console.log(`Error: ${err.message}`.red);
+ //Close server & exit process
+ server.close(() => process.exit(1));
+});
diff --git a/utils/errorResponse.js b/utils/errorResponse.js
new file mode 100644
index 0000000..29d4ac9
--- /dev/null
+++ b/utils/errorResponse.js
@@ -0,0 +1,8 @@
+class ErrorResponse extends Error {
+ constructor(message, statusCode) {
+ super(message);
+ this.statusCode = statusCode;
+ }
+}
+
+module.exports = ErrorResponse;
diff --git a/utils/geocoder.js b/utils/geocoder.js
new file mode 100644
index 0000000..223b636
--- /dev/null
+++ b/utils/geocoder.js
@@ -0,0 +1,12 @@
+const NodeGeocoder = require('node-geocoder');
+
+const options = {
+ provider: process.env.GEOCODER_PROVIDER,
+ httpAdapter: 'https',
+ apiKey: process.env.GEOCODER_API_KEY,
+ formatter: null,
+};
+
+const geocoder = NodeGeocoder(options);
+
+module.exports = geocoder;
diff --git a/utils/sendEmail.js b/utils/sendEmail.js
new file mode 100644
index 0000000..4ae0e2d
--- /dev/null
+++ b/utils/sendEmail.js
@@ -0,0 +1,25 @@
+const nodemailer = require('nodemailer');
+
+const sendEmail = async (options) => {
+ const transporter = nodemailer.createTransport({
+ host: process.env.SMTP_HOST,
+ port: process.env.SMTP_PORT,
+ auth: {
+ user: process.env.SMTP_EMAIL,
+ pass: process.env.SMTP_PASSWORD,
+ },
+ });
+
+ const message = {
+ from: `${process.env.FROM_NAME} <${process.env.FROM_EMAIL}>`,
+ to: options.email,
+ subject: options.subject,
+ text: options.message,
+ };
+
+ const info = await transporter.sendMail(message);
+
+ console.log('Message sent: %s', info.messageId);
+};
+
+module.exports = sendEmail;