Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #36

Merged
merged 1 commit into from
Dec 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 113 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@

ToDo API application made in a team. The client side is written on React, the server side on Django REST Framework.
In application has created user registration/authorization (JWT), user-profile-settings. The user can create a list of tasks, give them labels, delete, change and much more.
OAuth 2.0 added. For storage using MySQL.
Added OAuth 2.0 (Google). For storage using MySQL.

#### Stack:
##### Frontend:
- TypeScript
- JavaScript
- React.js
- HTML / CSS
##### Backend:
- Python
- Django
- Dajngo REST Framework
Expand All @@ -18,6 +21,113 @@ OAuth 2.0 added. For storage using MySQL.

Additional libraries are specified in the `requirements.txt` file.

## Project Setup on Windows
## Project Setup with Docker
In this section, we will deploy the project on PC using Docker and Docker Compose.

### - In development...
### - Cloning a Project from GitHub
Create a root directory on your computer, then open it in your code editor or terminal.
<br>
Next, write this command into the command line:
```powershell
git clone https://github.com/S0fft/BeBetter-ToDo.git .
```
You will see the project files appear in your directory.

### - Running Docker Desktop and Docker Compose
Afterwards, launch the already installed Docker Desktop. Next, while it is running, you can return to the editor or terminal and enter the following command in the terminal:
```powershell
docker-compose up --build
```
This command "collects and runs all the code", allowing you to interact with the project through a browser.

### - Check by Port
Now the project is already running on your computer, and is available on port 8000.
Go to this address to open it:
```powershell
http://localhost:8000/
```
Thus, we have run the project locally on computer. The server will indicate which links are available to you.

## <p align="center">Windows [Without Docker]</p>

### - Installing the Stack
To begin, install: [Python](https://www.python.org/downloads/) | [MySQL](https://www.mysql.com/downloads/) <br> Links are provided to the latest versions of the tools.
<br>

### - Cloning a Project From GitHub
All the same, сreate a root directory on your computer, then open it in your code editor or terminal.
<br>
Next, write this command into the command line:
```powershell
git clone https://github.com/S0fft/BeBetter-ToDo.git .
```
You will see the project files appear in your directory. After, continue to enter the following commands.

### - Creating a Virtual Environment
Create a virtual environment:
```powershell
python -m venv .venv
```

And activate it:

```powershell
.venv\Scripts\Activate
```

### - Installing the Requirements
Next, install packages:

```powershell
python.exe -m pip install --upgrade pip
```
```powershell
pip install -r requirements.txt
```

<!-- ### Fixtures
Load data from fixture for devices
```powershell
code
``` -->

### - Running the Server
Then, run server:
```powershell
python manage.py runserver
```
<br>

<!-- ---------------------------------------------- -->

## <p align="center">UNIX Systems [Without Docker]</p>
These commands do the same thing as described above, only on UNIX systems. <br> Before this, the code must be modified as indicated in the note above!
<br>

### - Virtual a Environment
```bash
python3 -m venv ../venv
```

```bash
source ../venv/bin/activate
```

### - Installing the Requirements
```bash
pip3 install --upgrade pip
```
```bash
pip3 install -r requirements.txt
```

<!-- ### Fixtures
```bash
code
``` -->

### - Running the Server
```bash
python manage.py runserver
```
</details>
Loading