https://github.com/aurelioo29/final-project-multiplatform
Final Project MultiPlatform use Django for BE
https://github.com/aurelioo29/final-project-multiplatform
django-rest-framework web-serial-api
Last synced: 2 months ago
JSON representation
Final Project MultiPlatform use Django for BE
- Host: GitHub
- URL: https://github.com/aurelioo29/final-project-multiplatform
- Owner: aurelioo29
- Created: 2024-05-16T05:01:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T12:40:16.000Z (over 1 year ago)
- Last Synced: 2025-01-20T13:48:25.724Z (about 1 year ago)
- Topics: django-rest-framework, web-serial-api
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Setup Guide
Follow these steps to set up and run the project in your local development environment.
## Prerequisites
Make sure you have Python installed on your system. You can download it from [python.org](https://www.python.org/downloads/).
## Installation Steps
1. Create a virtual environment using `venv`.
```bash
py -m venv env
```
Or if the above command doesn't work, use:
```bash
python -m venv env
```
2. Activate the newly created virtual environment.
For Windows users:
```bash
env\Scripts\activate
```
For macOS or Linux users:
```bash
source env/bin/activate
```
3. Install all required packages from `requirements.txt`.
```bash
pip install -r requirements.txt
```
4. Run the development server.
```bash
py manage.py runserver
```
## Explanation
- **Creating a Virtual Environment:** The first step is to create a virtual environment to ensure your project has isolated dependencies and does not conflict with globally installed packages.
- **Activating the Virtual Environment:** Activating the virtual environment ensures that any `pip` and `python` commands you run use the versions and packages within that environment.
- **Installing Requirements:** The `requirements.txt` file contains a list of all the Python packages needed for this project. The command `pip install -r requirements.txt` reads this file and installs all listed packages.
- **Running the Server:** The command `py manage.py runserver` starts the Django development server, allowing you to see your web application running in a browser.
## Notes
- Always ensure you have activated the virtual environment before running or developing this project.
- If you encounter issues, check that you have followed each step correctly and that all prerequisites are met.
Happy developing!