crowdbucks/crowdbucks-api
2
8
Fork 0
Code Issues Pull requests Activity
The back-end API for a CrowdBucks instance server.
54 commits 1 branch 0 tags 1.3 MiB
  • Go 97.4%
  • PLpgSQL 1.4%
  • HTML 1.2%
Find a file
Charles Iliya Krempeaux 24d4d9d887 github -> codeberg
2025-08-15 06:24:00 -07:00
.github/workflows Initial commit 2025-07-01 16:18:26 +03:30
app github -> codeberg 2025-08-15 06:24:00 -07:00
components github -> codeberg 2025-08-15 06:24:00 -07:00
playground feat: improve communities retrieval 2025-07-30 18:16:55 +03:30
providers github -> codeberg 2025-08-15 06:24:00 -07:00
test github -> codeberg 2025-08-15 06:24:00 -07:00
.dockerignore Initial commit 2025-07-01 16:18:26 +03:30
.gitignore Initial commit 2025-07-01 16:18:26 +03:30
API.md feat: improve community retrieval 2025-07-30 17:54:22 +03:30
config.yaml Initial commit 2025-07-01 16:18:26 +03:30
config.yaml.sample Initial commit 2025-07-01 16:18:26 +03:30
docker-compose.yaml Initial commit 2025-07-01 16:18:26 +03:30
Dockerfile Initial commit 2025-07-01 16:18:26 +03:30
go.mod github -> codeberg 2025-08-15 06:24:00 -07:00
go.sum fix: html sanitization 2025-07-31 18:54:04 +03:30
LICENSE Create LICENSE 2025-08-12 17:23:15 +03:30
main.go github -> codeberg 2025-08-15 06:24:00 -07:00
README.md github -> codeberg 2025-08-15 06:24:00 -07:00
staticcheck.conf Initial commit 2025-07-01 16:18:26 +03:30

README.md

Crowdbucks

⚠️ This project is under heavy development and should not be used in production yet.

image image image

🏎️ Running the Project

🚀 Using Go and Postgres

  1. Clone the project repository: 
    git clone https://codeberg.org/crowdbucks/crowdbucks-api
  2. Navigate to the project directory: 
    cd crowdbucks-api
  3. Create an empty Postgres database.
  4. Update the config.yaml file in the project root directory with the actual values for your database.
  5. Download the project dependencies: 
    go mod download
  6. Run the project: 
    go run main.go

🐳 Using Docker

  1. Clone the project repository: 
    git clone https://codeberg.org/crowdbucks/crowdbucks-api
  2. Navigate to the project directory: 
    cd crowdbucks-api
  3. Build the Docker image: 
    docker build -t crowdbucks-api .
  4. Replace the environment variables below with your own and run the Docker container: 
    docker run \
    --name crowdbucks-api \
    -e PROTOCOL=https \
    -e FQDN=yourdomain.com \
    -e PORT=7080 \
    -e POSTGRES_HOST=127.0.0.1 \
    -e POSTGRES_PORT=5432 \
    -e POSTGRES_DATABASE=crowdbucks \
    -e POSTGRES_USER=postgres \
    -e POSTGRES_PASSWORD=password \
    -p 7080:7080 \
    crowdbucks-api

🐳 Using docker-compose

  1. Clone the project repository: 
    git clone https://codeberg.org/crowdbucks/crowdbucks-api
  2. Navigate to the project directory: 
    cd crowdbucks-api
  3. Run the Docker containers using docker-compose: 
    docker-compose up

🌐 API Documentation