Worldly

A culinary class booking site focused on bring cultures together one bite ate a time
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Worldy is a cultural centered event booking focused on bringing people together. The site seeks to solve the problem of teaching how to cook different other cultures foods and learning a little bit about the culture in the process. The site was built upon a Flask/SQLAlchemy Backend and a React/Redux backend. It a full stack, feature rich website.

To Learn more about the features, user stories,and the development of the project please click here

Built With

• Flask
• React
• Redux

Getting Started

To get a local copy and (optional: a heroku deployed version) up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• pipenv

  pipenv install

Installation

1. Clone the Worldly repo

   git clone https://github.com/RyanGC93/Worldly

2. Backend Installation

• Follow Instructions for Backend Instructions

3. Frontend Installation

• Follow Instructions for Frontend Instructions

Project Challenges

Creating responsive querying that only return relevant information that is maximized for runtime efficiency and future scalability

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ryan Conk- Github - ryangconk@gmail.com - Project Link