Welcome to the pnyx-backend project, the backbone of our innovative platform designed to streamline and enhance user interactions through efficient data handling and user management. Our goal is to provide a robust backend system that supports seamless authentication, user login user stories, and real-time data processing.
This section guides you through setting up pnyx-server on your local environment, ensuring you have all the necessary tools and dependencies to run the application successfully.
Before you begin, ensure you have the following installed:
- Python (3.8 or later)
- pip (latest version)
- A web browser or API testing tool like Postman
Follow these steps to get your pnyx-backend running:
-
Clone the Repository
git clone https://github.com/ParthMiyani/pnyx-app.git cd pnyx-app/server -
Set Up a Virtual Environment
python3 -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install Dependencies
pip install -r requirements.txt
-
Run the Application
flask run
if using web browser/API testing tool The server will start on http://127.0.0.1:5000/. You can access it using your browser or an API testing tool.
- User Authentication: Secure login/logout functionality, including a "forgot password" feature.
- Data Processing: Real-time handling and storage of user data and preferences.
- To Login, send a POST request to
/loginwith username and password. - To Logout, access
/logout. - Use
/forgot-passwordto initiate a password reset.
Insert screenshots, animations, or links to videos here that showcase your application in action. For example:
- Login Flow:
- Reset Password:
Follow instructions above to deploy intial setup
To test the functionalities, you can use the above commands when implemented.
This project is a collaborative effort by our dedicated backend team:
- Rakan Alhamoury - Backend Team
- Vidhi - Backend Team