Code Monkey home page Code Monkey logo

col-client's Introduction

COL App

COL or Cognitive Off-Loader allows users to create calendar events with a date, title, and details for the scheduled event.

1. Working Prototype

You can access a working prototype of the React app here: https://col.zcason.vercel.app/ and Node app here: https://dry-headland-26786.herokuapp.com/api

2. User Story

Cover Page
  • As a visitor
  • I want to understand what this app entails to make a decision if I want to use it
Login Page
  • As a returning register user
  • I want to enter my email and password to use this app, so I can have access to my account.
Sign Up/Registration Page
  • As a visitor
  • I want to register to use this app so I can create a personal account.
My Home Page
  • As a logged-in user,
  • I can see the current month on the calendar component and the events I have already bookmarked for that month listed below. If I click a specific day the on calendar component the list of events change to show events bookmarked only for that specific day.
My Profile Page
  • As a logged-in user,
  • I can see my account information (name and email), and if I want to delete my account I can hit the delete button to do so.
Create Event Page
  • As a logged-in user,
  • I can create events to be scheduled on the day I choose, with a title, and a brief description or note for the event.

3. Screenshots

Cover Page
Cover Page
Login Page
Login Page
Sign Up/Registration Page
Sign Up/Registration Page
Home Page
Home Page
Proflie Page
Profile Page
Event Page
Event Page

4. API Documentation

API Documentation details:

  • GET All Events by Month

    • https://dry-headland-26786.herokuapp.com/api/home/:beginningOfMonth:endOfMonth
  • GET Profile

    • https://dry-headland-26786.herokuapp.com/api/profile
  • POST Event

    • https://dry-headland-26786.herokuapp.com/api/create-event
      • JSON body
      • { "Title": "Lunch with Client", "event_desc": "Bring Pitch Material ", "event_date": 2013-03-01T00:00:00+01:00, }
  • POST User

    • https://dry-headland-26786.herokuapp.com/api/create-account
      • JSON body
      • { "full_name": "John Doe", "email": "[email protected]", "password": "Password123!" }
  • DELETE Event

    • https://dry-headland-26786.herokuapp.com/api/home/:event_id
  • DELETE Profile

    • https://dry-headland-26786.herokuapp.com/api/profile/:user_id

5. Technology

  • Front-End: HTML5, CSS3, JavaScript ES6, React
  • Back-End: Node.js, Express.js, Mocha, Chai, PostgreSQL
  • Development Environment: Vercel, Heroku

6. How to run it

Use command line to navigate into the project folder and run the following in terminal

Local React scripts
  • To install the react project ===> npm install
  • To run react (on port 3000) ===> npm start
  • To run tests ===> npm run test
Local Node scripts
  • To install the node project ===> npm install
  • To migrate the database ===> npm run migrate
  • To run Node server (on port 8000) ===> npm run dev
  • To run tests ===> npm run test

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.