Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.19 KB

README.md

File metadata and controls

86 lines (54 loc) · 3.19 KB
Raw

React Event Scheduler App

codecov License: MIT

This project was bootstrapped with Vite.

Event Scheduler is a React app that allows users to create events. An event can be anything, such as a sport event, team meeting, party announcement, personal advertisement, etc. An event consists of title, start and end date/time, and description. Events can also be shared on FB or Twitter. All events are public by default (visible to everyone). They can also be private (only visible to you) by checking the private checkbox.

If you're looking for a frontend or backend starter project, check these out:

Demo 🎥

Tech Stack

Frontend

  • React (react hooks)
  • Typescript
  • Bootstrap/react-bootstrap
  • Styled components
  • Apollo client
  • JS cookie

Backend

  • NodeJS with Express
  • Typescript
  • Apollo server express
  • JSON web token
  • MongoDB with mongoose

Note that graphql schemas are generated on the frontend using GraphQL Code Generator. This means that if you make any changes to the schema (server/graphql/schema/index.ts), make sure that the .graphql files in the frontend are also updated accordingly.

Next, run yarn codegen to re-generate the queries and mutations (before you do this, make sure the server is up and running by either running yarn start or yarn start:server)

Run app locally

Make sure MongoDB is up and running

Create a .env file in the project's root directory, and copy & paste what's in .env.example, then run yarn:

yarn start

Runs the backend and frontend apps simultaneously in the development mode.

Or if you prefer running the apps separately by running yarn start:web and yarn start:server in separate terminals.

The app will automatically start at https://localhost:3000 in the browser.

You will also see any Lint or Typescript errors in the console.

Current functionality

  • User signup and login
  • Create, update and delete events
  • Search & pagination
  • Make events as private (only visible to creators)
  • Session expiry warning (displayed when being idle for 3 minutes after logging in)
  • Share events with family & friends on Facebook and Twitter

Coming soon

  • User profile
  • Admin tab & profile

Run unit tests

coming soon...

Run E2E tests

coming soon...

Author 📚

Ahmed Alatawi