Convoo

---

For keeping up to date with Conventions and Conferences!!
Rate, Review, and Favorite events!

📝 Table of Contents

• About
• Getting Started
• Deployment
• Running the Server Locally
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

Write about 1-2 paragraphs describing the purpose of your project.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Give examples

Installing

A step by step series of examples that tell you how to get a development env running.

If downloading to run locally:

1. Clone using the Repo URL
2. Open terminal, Navigate into the client folder, and run the below code to run

$ yarn dev

3. To run api, open a seperate terminal tab (do not close the other one). Navigate to the api folder and run

nodemon index.js

End with an example of getting some data out of the system or using it for a little demo.

🔧 Running the server locally

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

🎈 Usage

Add notes about how to use the system.

🚀 Deployment

Add additional notes about how to deploy this on a live system.

⛏️ Built Using

• MongoDB - Database
• Express - Server Framework
• VueJs - Web Framework
• NodeJs - Server Environment

✍️ Authors

• @robotgyal - Full-Stack Development

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References