Skip to content

Shayan-Bathaee/Localendar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

189 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Localendar

What is Localendar?

Localendar is a centralized event board that enables easy gathering and supports tightly knit communities. Whether you are looking to host a public event or you are seeking things to do nearby, Localendar can help. On the app, you can browse through events going on in any location, sorted by date or distance, and choose what you’d like to attend. Hosting events is easy too. Simply go to our "Create event" page, enter information like the name, date, and description, and post it.

Information about the development process can be found in this presentation.

How do I run Localendar?

As of right now, Localendar can only be run locally. First download this repository to your local machine. Next, follow these steps to run Localendar:

  1. Install Docker Desktop
  2. Run Docker Desktop
  3. Open a terminal and navigate to the Localendar > backend folder
  4. Run the command docker compose up
  5. Open a second terminal and navigate to the Localendar folder
  6. Run the command npm start
  7. Open a third terminal and navigate to the Localendar > frontend folder
  8. Run the command npm start

After following these steps, Localendar should start in your default browser. For instructions on how to run our unit tests, see the file Localendar > tests > test-desctiptions.pdf.

About

A React web app for posting and browsing events in your local area

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors