Skip to content

HACKING.md

Latest commit

 

History

History
49 lines (32 loc) · 1.91 KB

HACKING.md

File metadata and controls

49 lines (32 loc) · 1.91 KB

Working on the assets project

The ubuntu.com codebase is a Flask app, which builds on our own flask-base, templatefinder, blog and search packages.

We use Yarn for building static files like CSS through package.json scripts.

Setup

  1. To run the project simply, you will need to install dotrun, by following the installation instructions
  2. docker: Docker is used to run the project. You can install it by following the installation instructions
  3. docker-compose: Docker compose is used to run the Postgres database and the SWIFT server (files server), you can install it by following the installation instructions
  4. Taskfile: It is used to run everything with a single task command.

Running the project

Please make sure you are running the latest version of

Starting the project with all it's services is as simple as

task

That's it! The project should now be running at http://localhost:8017/manager.

You can stop the project using

task stop

Please checkout Taskfile.yml for all available commands

Generating API tokens

To generate a new API token, run:

dotrun exec flask token create test

To list all the API tokens, run:

dotrun exec flask token list