Boss Machine

Node.js/express API (CRUD) and front-end React project

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Project Requirements
4. Contact
5. Acknowledgments

About The Project

I was assigned this project as part of Codecademy's Full stack engineering bootcamp. I had to create an entire API to serve information to a Boss Machine, a unique management application for today's most accomplished (evil) entrepreneurs. Leveraging Express.js I created routes to manage the 'minions', the brilliant 'million dollar ideas', and to handle all the annoying meetings that keep getting added to the busy schedule.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Google Chrome (at least version 60) or Firefox (at least version 55)
• npm

  npm install npm@latest -g

Installation

1. Download the project
2. Install NPM packages

   npm install

3. If you have problems, you may have to

   npm install --force

4. Start local development server

   npm run start

5. View on http://localhost:4001/
6. To run testing

 npm run test

(back to top)

Project Requirements

1. Intial Setup

• Set up body-parsing middleware with the body-parser package.
• Set up CORS middleware with the cors package. You can use the default settings.
• Mount the existing apiRouter at /api. This router will serve as the starting point for all your API routes.
• Start the server listening on the provided PORT. Make sure to use the PORT constant and not a hard-coded number, as this is required for tests to run.

2. Minions Routes

• GET /api/minions to get an array of all minions.
• POST /api/minions to create a new minion and save it to the database.
• GET /api/minions/:minionId to get a single minion by id.
• PUT /api/minions/:minionId to update a single minion by id.
• DELETE /api/minions/:minionId to delete a single minion by id.

3. Ideas Routes

• GET /api/ideas to get an array of all ideas.
• POST /api/ideas to create a new idea and save it to the database.
• GET /api/ideas/:ideaId to get a single idea by id.
• PUT /api/ideas/:ideaId to update a single idea by id.
• DELETE /api/ideas/:ideaId to delete a single idea by id.

4. Meetings Routes

• GET /api/meetings to get an array of all meetings.
• POST /api/meetings to create a new meeting and save it to the database.
• DELETE /api/meetings to delete all meetings from the database.

5. Custom Middleware

• Create custom middleware function to ensure that any new or updated idea is worth at least a million dollars.

6. Bonus

• Create work routes that allow bosses to add and remove work from their minions' backlogs.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Patrick Alvarez Eades - [email protected]

Project Link: https://github.com/Patchalv/boss-machine

(back to top)

Acknowledgments

A big shout out to Codecademy who I'm currently doing the Full-Stack Engeineer career path with!

(back to top)