https://github.com/philiptitus/squareapi

Official source code for square api the engine behind ReUp Platform.
https://github.com/philiptitus/squareapi

django django-rest-framework gemini-api

Last synced: 3 months ago
JSON representation

Official source code for square api the engine behind ReUp Platform.

• Host: GitHub
• URL: https://github.com/philiptitus/squareapi
• Owner: philiptitus
• License: mit
• Created: 2024-07-24T20:04:33.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-11-11T20:00:07.000Z (7 months ago)
• Last Synced: 2025-01-19T05:37:15.969Z (5 months ago)
• Topics: django, django-rest-framework, gemini-api
• Language: Python
• Homepage: https://squareapi.pythonanywhere.com
• Size: 430 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.MD
  • License: LICENSE

Awesome Lists containing this project

README

        

# SquareAPI

## Overview

**SquareAPI** is a Django-based application designed to ease community trash collection. 

## Installation

### Prerequisites

Ensure you have the following installed:

- [Python](https://www.python.org/downloads/) (>=3.8)

- [pip](https://pip.pypa.io/en/stable/) (Python package installer)

- [virtualenv](https://virtualenv.pypa.io/en/latest/) (for creating isolated Python environments)

### Setting Up the Environment

1. **Clone the repository:**

   ```sh

   git clone https://github.com/philiptitus/squareapi.git

   cd squareapi

    Create and activate a virtual environment:

    sh

python -m venv env

source env/bin/activate  # On Windows use `env\Scripts\activate`

Install the required packages:

sh

pip install -r requirements.txt

Apply migrations:

sh

python manage.py migrate

Create a superuser (admin):

sh

python manage.py createsuperuser

Run the development server:

sh

    python manage.py runserver

    The application will be available at http://127.0.0.1:8000/.

Configuration

Update your configuration files if necessary:

    .env: Add your environment-specific variables in the .env file.

    Example:

    makefile

    SECRET_KEY=your-secret-key

    DEBUG=True

    ALLOWED_HOSTS=localhost,127.0.0.1

    settings.py: Ensure you configure the database settings and other environment-specific settings.

Running Tests

To run tests, use:

sh

python manage.py test

Deployment

For deployment instructions, refer to the Deployment section of the documentation.

Contributing

    Fork the repository.

    Create a new branch (git checkout -b feature/YourFeature).

    Commit your changes (git commit -am 'Add new feature').

    Push to the branch (git push origin feature/YourFeature).

    Create a new Pull Request.

License

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

Contact

For any questions or issues, please contact me.

SquareAPI © [2024] by [Philip Titus].

Released under the MIT License.