README.md

Eventopia

Connecting you with your passion

Planning a trip and need to keep track of all your vacation activities? Or maybe you just like to be in the know with local entertainment. With Eventopia you can search and keep all your fun events in one place!

🗺️ Navigate To:

• 📦 Getting Started
• 🚀 Deployment
• 🔧 Built With
• 📜 Authors
• 📝 License
• 🥂 Acknowledgments

📦 Getting Started

$$\textsf{\color{#3271D6}Start \color{#F59E0B}App}$$

Backend

To deploy this app locally, find our backend codebase here.

Prerequisites

You will need a few environment variables to get this running. Create a .env file in both the backend folder and the frontend folder.

Here are the required environment variables:

Backend:

TICKETMASTER_API_KEY=YOUR_KEY
MONGO_URI=YOUR_KEY
JWT_LIFETIME=YOUR_KEY
JWT_SECRET=YOUR_KEY
PORT=YOUR_KEY
SMTP_HOST=YOUR_KEY
SMTP_PORT=YOUR_KEY
SENDER_EMAIL=YOUR_KEY
SENDER_EMAIL_PASSWORD=YOUR_KEY
JWT_SECRET_CSRF=YOUR_KEY

Frontend:

VITE_API_BASE_URL=YOUR_KEY

Installing

In both the backend and the frontend folders you will need to run npm i to install the dependencies.

🚀 Deployment

$$\textsf{\color{#3271D6}Deploy \color{#F59E0B}Fast}$$

To deploy this app live, you will need to:

1. Deploy your backend folder.
2. Change the frontend VITE_API_BASE_URL key's value to the live backend URL.
3. Deploy your frontend folder.

🔧 Built With

$$\textsf{\color{#3271D6}The \color{#F59E0B}Tools}$$

• React - Frontend Javascript library
• Vite - Frontend build tool
• MongoDB - Backend database
• Express - Backend framework for Node.js

📜 Authors

$$\textsf{\color{#3271D6}Our \color{#F59E0B}Team}$$

Frontend

• Uma Sekar - frontend developer - Uma's Github
• Nihal Erdal - frontend developer - Nihal's Github
• Stu MacLeod - frontend developer - Stu's Github
• Maria Domarkas - frontend developer - Maria's Github

Backend

• Amanda Hockmuth - backend developer - Amanda's Github
• Sisi Wang - backend developer - Sisi's Github

📝 License

$$\textsf{\color{#3271D6}Legal \color{#F59E0B}Stuff}$$

This project is licensed under the MIT License - see MIT License for details

🥂 Acknowledgments

$$\textsf{\color{#3271D6}Thank \color{#F59E0B}You}$$

• Our amazing mentors who helped guide us along the way!

  • Josh Goldenburg - mentor - Josh's Github
  • Katherine Lashcheuskaya - mentor - Katherine's Github
  • Rebeca Vassoler Gallo - mentor - Rebeca's Github

• Code The Dream for creating this learning environment! - CTD's Website