Cleanwalk V2 website and webapp

Cleanwalk.org is a website to find clean walks all over France.

Table of Contents

• Frontend
• API

Requirements

• Docker and docker compose install link ->
• node.js install link ->
• (optional) python3 install link ->

environement

Create a .env file in the api and front directories and follow the .env.example schema.

How to launch

Developement

To launch the app on dev environnement, use the docker compose tool at the root directory of the project.

API ->

docker compose up -d

or

• go in api Directory -> cd api
• install

pip install -r requirements.txt

• launch

docker compose up -d

To down API

docker compose down

⚠️ Tips : with docker Adminer is launched on port :8080

Frontend ->

• go in api Directory -> cd api
• install

npm install

• run on port 5173

npm run dev

Production

lauch

docker-compose -f "docker-compose.prod.yml" up -d --build

###"" config nginx proxy manager

first login: connect to @server_ip:81

• username: [email protected]
• password: changeme ! change admin info

proxy hosts Go to Hosts > Proxy Hosts and click on Add Proxy Host.

frontend

• Domain Names: yourdomain.example, www.yourdomain.example
• Scheme: http
• Forward Hostname / IP: frontend
• Forward Port: 80

API

• Domain Names: api.yourdomain.example
• Scheme: http
• Forward Hostname / IP: api
• Forward Port: 5000

uploads

• Domain Names : uploads.yourdomain.example
• Scheme : http
• Forward Hostname / IP : nginx-proxy-manager
• Forward Port : 81

in advanced add:

location / {
    alias /var/www/uploads/;
    autoindex on;
}

SSL Config

• check Force SSL
• select Request a new SSL certificate
• add email and save