8000 GitHub - em1le/urban-octo-winner
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
This repository was archived by the owner on May 17, 2023. It is now read-only.

em1le/urban-octo-winner

Repository files navigation

urban-octo-winner

Heroku Deploy

Introduction

To be honest, I started wednesday night around 9pm and I did not have a clue what application to show you.

What should i think ?

So this modest project is a platform where a media content creator can catalog and take inventory of its work.

Global user case

As a media content creator :

  • I want to add articles to my account
  • I want to add references to my articles
  • I want to have a global view of my catalog
  • I want to make CRUD operation on my articles

UML

UML Diagram

Pre-requisites

Ask me the environment variables files else you would not be able to have a correct experience on the app.

Docker installation

Docker

First you have to make sure that docker is installed on your local environment.

Try the following command :

$ docker --version

If it show something such as Docker version 20.10.12, build e91ed57 it should be fine.

Otherwise follow tutorial on docker

Docker Compose

We need docker compose installed in order to make it work. As written on docker part, you should try the following command to check if docker is installed :

$ docker-compose --version

If something like docker-compose version 1.29.2, build 5becea4c pops up it's fine in the other hand you would have to take a look on how to install docker-compose

Let's do it

The basic stuff is installed to make it work. Thus launch followings :

$ docker-compose up --build

Afterwise, you should access localhost:8000 or 127.0.0.0:8000

From scratch

You might also want to install without docker, just a few steps more to have a project running :

Clone the repo

Choose the right place to store you project and do as follow :

$ git clone git@github.com:em1le/urban-octo-winner.git

Go inside the clone folder

$ cd urban-octo-winner
Create a venv

As your at your folder's root you may launch the following command :

$ python3 -m venv catalog-env

A fresh folder has just been created under the catalog-env name. Then you must source the env :

$ source catalog-env/bin/activate

Fine enough, let's install the requirements :

$ pip install -r requirements.txt

Migrate

Run the command ./manage.py migrate

Fire it up

Run the comman ./manage.py runserver

You should now be able to see the application

Todo

  • Add locust
  • Add more useful data to dashboard
  • Add more pertinent tests

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

0