https://github.com/brownboycodes/fruitcastle

Fruit Castle is a web application intended to serve as common centralized backend service provider for a wide range of apps requiring different types of data
https://github.com/brownboycodes/fruitcastle

api backend-server common-api-server flask flask-application fruit-castle fruitcastle python python3

Last synced: 3 days ago
JSON representation

Fruit Castle is a web application intended to serve as common centralized backend service provider for a wide range of apps requiring different types of data

• Host: GitHub
• URL: https://github.com/brownboycodes/fruitcastle
• Owner: brownboycodes
• License: other
• Created: 2021-10-20T05:35:53.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-31T07:31:13.000Z (over 2 years ago)
• Last Synced: 2023-03-03T21:22:04.379Z (over 1 year ago)
• Topics: api, backend-server, common-api-server, flask, flask-application, fruit-castle, fruitcastle, python, python3
• Language: Python
• Homepage: https://fruitcastle.herokuapp.com/
• Size: 47 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# FruitCastle 🍎🏰

**FruitCastle** is a web application built with Flask and Python intended to act as a common backend service for hosting data that is will be used by various cross-platform and web applications.

![FruitCastle banner](./src/fruit_castle/client/dist/images/fruitcastle_logo_banner/fruitcastle-logo-banner-ae2012-212529-ffffff.png)

## View deployed app  🚀🎉🎊

[https://fruitcastle.herokuapp.com/](https://fruitcastle.herokuapp.com/ "Common Backend Service for hosting API and data")










## Installation Guidelines

Clone the repo to your computer, execute to the following commands in CMD or Bash:

```bash

git clone https://github.com/brownboycodes/FruitCastle.git

```

access the downloaded directory 📁:

```bash

cd FruitCastle

```

setup virtual environment for Python 🐍:

```bash

py -3 -m venv venv

```

activate virtual environment:

```bash

venv\Scripts\activate 

```

install packages 📦 required by the flask app 🐍:

```bash

pip install -r requirements.txt 

```

To test the server in `dev mode` 👨‍💻, create a file, for example- `run_dev_mode.py` and paste the following code 🐍:

```python

from src.fruit_castle.main import app, socketio

from src.fruit_castle.hadwin.v3.v3_socket_events import *

if __name__ == "__main__":

    app.config.update(

        TESTING=True,

        ENV='development',

    )

    if app.config['ENV'] == 'development':

        from dotenv import load_dotenv

        load_dotenv()

    app.config['SECRET_KEY'] = os.environ['SECRET_KEY']

    socketio.run(app, host="0.0.0.0", port=5000, debug=True)

```

🎉 Now, start the server in `development mode` 🚀:

```bash

py run_dev_mode.py

```




---

> [FruitCastle](https://fruitcastle.herokuapp.com/) © 2022 was developed by Nabhodipta Garai and is owned by him.