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 ๐
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.
This is an example of how to list things you need to use the software and how to install them.
-
Access Github https://github.com
-
Clone the repo
git clone https://github.com/lupamo3/flask-rest-api.git
-
Change directory into the flask-rest-api directory :
cd flask-rest-api
-
Create and activate your virtual environment :
Virtual venv python=[Python-Version] Pip install auto-env
-
Install Project Requirements
pip install -r requirements.txt
- Run the application
flask run
- Run CertificateTest on your postman to test the URLs
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 |
- 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
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Your Name - @nlanjichi
Project Link: https://github.com/lupamo3/flask-crud/tree/master