Table of Contents

1. Introduction
   • Requirements
   • Built With
2. Getting Started
3. Running Locally
4. Documentation

Introduction

Vote for Meeting is a Doodle-clone web app that lets users schedule meetings by creating events, setting options for the available dates and times and sharing with other users who can vote in order to decide on the most wanted option. The application is built with React, TypeScript, Node.js, Express, PostgreSQL, Prisma ORM, Docker and Git.

Requirements

This project requires the following software:

• Docker
• Docker Compose

Built With

The app has been built with the following technologies:

• React
• TypeScript
• Node.js
• Express
• PostgreSQL
• Prisma ORM
• Docker
• Git

(back to top)

Quickstart

1. Clone the repo

git clone https://github.com/AYanchev01/Vote-for-meeting.git

2. Copy .env.template to .env and set up the variables or leave the default ones.

3. Compose the project

docker-compose up --build -d

4. Access the application

After your Docker environment is up and running, navigate to http://localhost:3000/

Enjoy using the Vote for Meeting web app!

Running locally

• Install Node.js
• Install PostgreSQL
• Clone the repo - git clone https://github.com/AYanchev01/Vote-for-meeting.git
• Copy .env.template to .env and fill in the variables.
• Run npm install in server/ and client/
• Run npx prisma migrate dev and npx prisma generate in server/
• Run npm start in server/
• Run npm start in client/

• Navigate to http://localhost:3000/

(back to top)

Documentation

• You can access the api documentation by starting the server and visiting here.

(back to top)