virtual-felix / phoenix

Phoenix

All you can see for now is ash and light distorted by the heat.

Development

API

cd api
cargo build

or (with docker)

docker build -t ph-api:dev .

then to run

cargo run

or (with docker)

docker run -it --init --rm \
-p 3001:3001 \
-e ROCKET_PORT=3001 -e ROCKET_ADDRESS=0.0.0.0 \
-v ${PWD}/src:/usr/src/api/src \
ph-api:dev

APP

cd app

npm install

or (with docker)

docker build -t ph-app:dev .

then to run

npm start

or (with docker)

docker run -it --rm \
-v ${PWD}:/app \
-p 3000:3000 \
-e CHOKIDAR_USEPOLLING=true \
ph-app:dev

Docker compose (recommanded)

You can also build and run everything at once with docker compose

docker-compose build

docker-compose up

Production

In production, using docker compose is highly recommanded.

docker-compose -f docker-compose.prod.yml build

docker-compose -f docker-compose.prod.yml up

The app will be accessible on port 80.

More option will be available later to be able to tweak every possible thing and fully respect the twelve factors.

phoenix's Issues

PH-03 Docker compose deployment

Goal
Be able to deploy the whole application with docker compose.

Constraints

• Lazy deployments (super easy deployment with a single docker compose cmd)
• Dev run
• Prod deployment
• Fully configurable (12 factors)

Comments

• When running the dev docker while the node modules where not installed locally, it creates a node_modules folder through the container making it root owned. It might be an issue if the user npm install right after (can't write in node_modules). Something should be done to avoid this, either by creating the folder (if it does not exist) before running the docker or else.

PH-04 App theme

Goal
Make the page template with a clean design.

Constraints

• Page header
• Tabs structure for several list
• Colored theme & dark theme
• List mock up

PH-06 Add database

Goal
Install a database and use it to persist todo items.

Constraints

• Make a docker container for it
• Persist the todo items

PH-01 Base webapp

Goal
Create the Hello World web page with React and Material-ui.

Constraints

• Run-able with Docker
• Cleaned from all the unnecessary things generated by CRA

PH-08 Implement list model

Goal
Create a list domain model with an unique identifier and a not-unique name and add a list ID attributes to the quests. The objective is to be able to have multiple list that can be identified.

Constraints

• List domain model (UUID, name)
• List UUID in quest domain model

PH-05 List items CRUD

Goal
Create several routes on the API to add the ability to create, read, update and delete items from a list.

Constraints

• Create a todo route
• List todos route
• Get a todo route
• Update a todo route
• Delete a todo route

Comment
Do not persist in database yet. Use memory only.

PH-02 Base Rust API

Goal
Create the base rust API.

Constraints

• Single HTTP route which answers Hello World on "/"
• Run-able with Docker on port 8000

Implication
Chose a Rust API library.

PH-07 implement simple todolist on the UI

Goal
Use the CRUD routes on the API and create a simple Todolist on the UI able to create, update and delete items.

Constraints

• Create an item
• Delete an item
• Update an item
• Display all the item
• First unit tests