chore: Update repository URL and improve formatting
Changes the repository URL in the README to reflect the new private Git host. Enhances readability by adding spacing before code blocks. Ensures clearer instructions for users setting up the project.
This commit is contained in:
parent
2ec527adb5
commit
6d5741776b
1 changed files with 9 additions and 1 deletions
10
README.md
10
README.md
|
@ -24,37 +24,44 @@ Kumify is a personal management tool designed to track and manage various aspect
|
|||
### Steps
|
||||
|
||||
1. **Clone the repository**:
|
||||
|
||||
```bash
|
||||
git clone https://your-repo-url/kumify.git
|
||||
git clone https://git.private.coffee/kumi/kumify.git
|
||||
cd kumify
|
||||
```
|
||||
|
||||
2. **Create a virtual environment and activate it**:
|
||||
|
||||
```bash
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
3. **Install the required packages**:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. **Configure the settings**:
|
||||
|
||||
- Copy `settings.dist.ini` to `settings.ini` and edit as necessary with your configurations (e.g., database settings).
|
||||
|
||||
5. **Prepare the database**:
|
||||
|
||||
```bash
|
||||
python manage.py makemigrations
|
||||
python manage.py migrate
|
||||
```
|
||||
|
||||
6. **Create a superuser for administrative access**:
|
||||
|
||||
```bash
|
||||
python manage.py createsuperuser
|
||||
```
|
||||
|
||||
7. **Run the development server**:
|
||||
|
||||
```bash
|
||||
python manage.py runserver
|
||||
```
|
||||
|
@ -90,6 +97,7 @@ This project includes additional tools and dependencies specified in `requiremen
|
|||
### Development Commands
|
||||
|
||||
- **Format code with Black**:
|
||||
|
||||
```bash
|
||||
black .
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue