Skip to content
This repository has been archived by the owner on Aug 11, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wpf500 authored May 8, 2024
1 parent e6af222 commit 04f31dd
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ docker compose up -d
docker compose run --rm app node built/tools/new-user
```

### Payment methods and email domain
#### Payment methods and email domain

```bash
docker compose exec app node built/tools/configure
Expand Down Expand Up @@ -97,17 +97,15 @@ npm run dev:api
#### Rebuilding containers

If you make changes to `.env` you need to recreate the Docker containers
```
docker compose up -d

```

If you change the dependencies in `package.json` you must rebuild and recreate the Docker containers

```

docker compose build
docker compose up -d

```

#### Generating database migrations
Expand All @@ -117,16 +115,12 @@ file. TypeORM will automatically generate a migration file based on your schema
changes

```

docker compose start db
docker compose run app npm run typeorm migration:generate src/migrations/MigrationName
npm run build
docker compose run app npm run typeorm migration:run

```

> Note: If you get an `EACCES: permission denied` error, you may need to run the above commands with `docker compose run -u root`.
### 📰 Documentation

Documentation is currently very limited, please [contact us](#contact-us) and we will try to adapt the documentation accordingly.
Expand All @@ -138,59 +132,47 @@ The codebase is broadly split into a few different parts
Shared between all services (API, webhooks and legacy)

```

./src/core
./src/models - Data models and database entities
./src/config - Config loader

```

- **API service**
```

./src/api

```
- **Webhook service**

Handlers for webhooks from beabee's integrations (currently GoCardless, Mailchimp and Stripe)

```

./src/webhook

```

- **Legacy app**

This is slowly being removed, with business logic being moved into the API and frontend into the [new frontend](https://github.com/beabee-communityrm/beabee-frontend/).

```

./src/apps
./src/static
./src/views

```

- **Tools**

Various tools for administration, including nightly cron jobs

```

./src/tools

```

- **Database migrations**

Autogenerated by TypeORM

```

./src/migrations

````
#### 🤲 Common Package
Expand Down

0 comments on commit 04f31dd

Please sign in to comment.