Skip to content

Dev #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 25, 2025
Merged

Dev #10

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b93ca6a
Fix: typo in NODE_ENV variable in .env.sample
rootimes Jun 25, 2025
62bea8d
chore: add docker compose file
rootimes Jun 25, 2025
dd013a6
docs: update README to clarify server functions and setup instructions
rootimes Jun 25, 2025
b46df0f
Merge pull request #9 from rootimes/dev
1ilit Jun 25, 2025
0c99e25
Merge branch 'main' into dev
1ilit Jun 25, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: update README to clarify server functions and setup instructions
  • Loading branch information
@rootimes
rootimes committed Jun 25, 2025
commit dd013a66cbf7f2f3bed4c8fca357652cd3d2e054
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
Simple server to handle form submissions via email for drawDB.
This is a simple server that serves as the backend for drawDB. It has 2 functions:

### Get started
1. Send bug reports via email
2. Handle interfacing with the GitHub REST API

Set up the environment variables following `.env.sample`
### Getting Started

Set up the environment variables by following `.env.sample`

```bash
git clone https://github.com/drawdb-io/drawdb-server.git
cd drawdb-server
npm install
npm start
```

### Docker Compose run in dev

```bash
docker compose up -d
```