lizzieb1416 / wa_backend

White App Flask Backend

Table of Contents

1. Introduction
   • Dependencies
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgements

Introduction

A Flask Backend for a basic todolist accessing a db to store data and saving/loading a backup file

Getting Started

Prerequisites

• At least python 3.7 is required.
• Installing pip is highly recommanded as it will facilitate installation steps

Installation

• With pip
  • Install package

    pip install wa_backend @ git+ssh://[e-mail]:lizzieb1416/wa_backend.git@0.0.1

• From repository
  • Clone the repo

      git clone <Repo>

  • Install

      pip install .

    If you want to install it in development mode

      pip install -e .

Usage

wa_backend is called by wa_frontend and use a db and a file storage

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Liset Bastidas Gonzalez - [e-mail]