README.md

Palendar

https://thepalendar.netlify.app/

Contributors

• Anish Kakaiya
• Russell Morbey
• Erlantz Ramos
• Laura Voss
• Slava Yates

Description

This app allows you to schedule a time to hang out with friends within your busy lifestyle. After signing up you'll be able to populate your calendar with your own personal events.

You can then create a group event, where your calendar gets cross referenced with your friends calendars, and determines which days you are all available to hang out.

You also have a choice of who you would like to include in the shared calendar, keeping it private.

Technologies Used

MERN Stack

• MongoDB | No-sql Database integrated on cloud platform Atlas.
• Express | Web framework for Node.js (Back-end Development).
• React | JavaScript library for building user interfaces (Front-end Development).
• NodeJS | JavaScript runtime built on Chrome's V8 JavaScript engine (Back-end Development).

Notable Others

• Nodemon | Reloads the server automatically.
• Mongoose | Models objects in MongoDB.
• ESLint | Linting.
• Jest | Testing.
• React Testing Library | Frontend unit testing.
• HTML | Markup language.
• CSS | Style sheet language.
• [bcrypt] (https://www.npmjs.com/package/bcrypt) | User password encryption and authentication.
• [Cypress] (https://www.cypress.io/) | end to end testing.

Organisational & Planning Tools

• Trello | Kanban tool.
• Slack | Communication tool.
• Miro | Diagramming tool.
• Balsamiq | Wireframing tool.

MVP, design and planning

Homepage

Sign Up

Sign In

Personal Calendar

Event Calendar

Team Approach

• Agile Development.
• TDD.
• Early project planning.
• MVP.
• Regular check-in with team members for blockers.

Work hours

• Start time 9:45am.
• Lunch 12:30pm - 1:30pm.
• End day 6:00pm.

Daily stand ups and retros.

• Stand ups. 9:45am -10:00am.
• Retro. 5:30pm.

Demo Photos

Homepage:

Sign up:

Login:

Your personal calendar:

The group calendar:

Future Improvements

• Add the option to make friend requests.

How to Run Locally

1. Fork this repository
2. Rename your fork to Palendar
3. Clone your fork to your local machine
4. Install Node.js dependencies

   npm install
   

5. Install an ESLint plugin for your editor. For example: linter-eslint for vscode.

Start Server

npm start

Please leave this terminal running in the background.

Start Client

You will need to also clone the palendar-frontend repository on my profile here. Open a new terminal.

npm start

Please leave this terminal running in the background, the application should open automatically.

Test

• Run all tests

  npm test
  

• Run a check

  npm run lint              # linter only
  npm run test:unit         # unit tests only
  npm run test:integration  # integration tests only