Skip to content

Commit

Permalink
Added some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ruben69695 committed Jun 17, 2022
1 parent 996aa85 commit 8bb34f5
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
# Personal Web
My personal and professional web made with Python and Django.

![Heroku](https://heroku-badge.herokuapp.com/?app=rarrebola-personalweb)

## Requirements
1. Docker and Docker Compose installed on your machine
2. Python, Django and PostgreSQL knowledge

## Getting started
1. Clone the repository
```bash
git clone https://github.com/ruben69695/personalweb.git
```
2. Open the root of the project in your terminal
```bash
cd personalweb
```
3. Export in your system environment a new secret key necessary for docker compose, you can [generate a new one](https://djecrety.ir/)
```bash
export DJANGO_SECRET_KEY="Your new secret key goes here"
```
3. Build and stand up the services using docker compose
```bash
docker compose up --build -d
```
4. Now [open your browser](http://127.0.0.1:8000/)
5. Easy and enjoy 🍻

## Languages and versions
- Python 3.9.13
- Django 4.0.4
- pip 20.3.4
- Postgresql 14.3

## Development environment
- Debian Bullseye 11
- VSCodium v1.86.0
- NVIM v0.4.4

## Architecture
- Server - Client

## Production Deployment
- Heroku Platform

## Runs on
- Linux
- MacOS
- Windows
- Docker

0 comments on commit 8bb34f5

Please sign in to comment.