QueensCoder / campusproject

campus project using React Redux Node Express Sequelize and PostGres

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Senior Enrichment Project

Getting started

  1. Fork and clone this repo
  2. npm install
  3. Read the rest of this README.md carefully - it contains the requirements for the project and the grading rubric that will be used to assess it
  4. Check out the mock-view in the wireframes folder to get an idea of what the project could look like
  5. Start the build process and your application with: npm run start:dev. If you using Windows, you may need to execute npm run start-server and npm run build-watch separately (in their own terminal tabs).
  6. If you navigate to the URL you should see some UI already :) [We already have some connection code to get you started]
  7. Check out the starting seed file in seed.js - you can run it by executing npm run seed

Details

The Premise

You are the CTO of the Margaret Hamilton Interplanetary Academy of JavaScript. Create a RESTful web platform that allows you to manage your students and campuses. Before getting started, please carefully review the expectations as outlined below.

The tools

For this project, you must use Express to handle HTTP requests and Sequelize to interface with your database. Likewise, you must use React, Redux and React-Redux on the front-end. This means that all important state (i.e. students and campuses) must be managed by the Redux store (unimportant state, like form data, may be managed by stateful React components). Components that display student/campus data should therefore be connected to the Redux store. If you perform side-effects (like AJAX requests), you should encapsulate them in thunks.

Requirements + Rubric

For the requirements and rubric, refer to the following two files:

  • REQUIREMENTS.md - contains the functional requirements of the project
  • RUBRIC.md - contains the grading rubric for additional factors, as well as the formula for calculating the total score

Make sure to read them carefully!

Views and Functionality

Take a look in the wireframes folder as a reference for how your front-end could look. Of course, you are encouraged to be creative and flex your own design muscles, but the wireframes should function as a good baseline/inspirational resource. Either way, the most important part of the project is that it works - design/appearance is extra-credit. If there ever appears to be a conflict between the wireframes and the rubric/requirements below, go with the letter of the rubric/requirements.

Other Important Info

How to test functionality without a frontend

  • GET: use your browser
  • POST / PUT / DELETE :
  • CLI (command line interface) with curl
    • e.g. curl -H "Content-Type: application/json" -X POST -d '{"username":"kate","password":"1234"}' http://localhost:3000/api/login
    • -H: headers. -X: verb. -d: data (must be of the type specified in headers). http://[address]:[port]/[route_path]
  • Postman
  • Databases: use Sequelize in your routes and see if you are receiving what you expect

Video Walkthrough

Please submit a 5 to 10 minute screencast of a walk-through of the functionality and code for each user story in your app. E.g. for "As a user, I can create a campus", please show us that you can successfully create a campus in your app, and also the actual code that is involved in doing that (from the front-end components to the backend routes and models). We recommend using Quicktime to record the screencast (instructions on how to do that here).

Once you've recorded your screencast, please upload it to YouTube as an unlisted video. Email academics@fullstackacademy.com with the title Senior Enrichment Submission: [Your Name] and include your repo link and YouTube recording link. This will aid us in evaluating your submission.

Evaluation

  • Requirements score (75%)
  • Rubric score (25%)
  • Extra credit (15% max)

About

campus project using React Redux Node Express Sequelize and PostGres


Languages

Language:JavaScript 97.4%Language:CSS 2.1%Language:HTML 0.5%