Giter Club home page Giter Club logo

flask-rest-api's Introduction


Flask Lead Creation and Customer Creation API

About The Project

An application that allows users to create leads, create customers, view leads, edit leads, edit their customers, view customers.

.

Here are some of the features:

  • Create Leads
  • Create Customers
  • Edit Leads
  • View Users
  • Edit their profiles
  • It has implemented DRY principles ๐Ÿ˜„

Built With

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

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

Installation

  1. Access Github https://github.com

  2. Clone the repo

    git clone https://github.com/lupamo3/flask-rest-api.git
  3. Change directory into the flask-rest-api directory :

    cd flask-rest-api
  4. Create and activate your virtual environment :

    Virtual venv python=[Python-Version]
    Pip install auto-env
  5. Install Project Requirements

pip install -r requirements.txt
  1. Run the application
flask run

Test the application on Postman

Test The API end-points

or use:

URL METHOD MESSAGE
/api/users/register POST Create a leads/customer admin.
/api/users/login POST Login to profile.
/api/users/all GET Get all users
/api/users/edit PUT Edit Specific User records
/api/users/logout POST Logout of the platform
/api/leads/create POST Create a lead record
/api/leads/all GET View all leads.
/api/customer/create POST Create a Customer .
/api/customer/all GET Get all customers

Additional Information

  • Feel free to reach me via email and to fork this project
    • Any feedback would be appreciated.
    • The Pull requests have bit by bit application documentation

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

License

License: MIT

Contact

Your Name - @nlanjichi

Project Link: https://github.com/lupamo3/flask-crud/tree/master

flask-rest-api's People

Contributors

lupamo3 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.