Skip to content

Commit 88f4d5a

Browse files
author
Nap Joseph Calub
committed
docs: update docs
1 parent 606541b commit 88f4d5a

3 files changed

Lines changed: 47 additions & 45 deletions

File tree

DEVELOPMENT.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,7 @@ volume.
4444

4545
### 1. Create a `.env` file
4646

47-
Copy the example below to a file named `.env` in the project root (do NOT commit
48-
real secrets):
49-
50-
```env
51-
SURREALDB_ROOT_USERNAME=your_secure_user
52-
SURREALDB_ROOT_PASSWORD=your_secure_password
53-
SURREALDB_LOG_LEVEL=info
54-
SURREALDB_PORT=8000
55-
```
47+
Copy the `.env.example` file to `.env` and fill in the values.
5648

5749
### 2. Start SurrealDB (Detached Mode)
5850

@@ -75,23 +67,17 @@ docker compose up -d
7567

7668
### 3. Persistent Storage
7769

78-
- Data is stored in the `mydata` directory in your project root, which is
79-
mounted into the container.
70+
- Data is stored in the `data` directory in your project root, which is mounted
71+
into the container.
8072
- This means your database persists across container restarts and
8173
`docker compose down/up` cycles.
82-
- To inspect the data, look in the `mydata` directory.
74+
- To inspect the data, look in the `data` directory.
8375
- To remove all data (dangerous!):
8476
```sh
8577
docker compose down -v
86-
rm -rf mydata/*
78+
rm -rf data/*
8779
```
8880

89-
### 4. Security Best Practices
90-
91-
- **Never commit your `.env` file** with real secrets to version control.
92-
- Use a `.env.example` with placeholder values for contributors.
93-
- For production, use a secrets manager or CI/CD environment variables.
94-
9581
---
9682

9783
## Database Bootstrapping and Multi-Tenant Setup
@@ -123,7 +109,7 @@ the tenant to the root user by email:
123109
```sh
124110
deno task tenants create <name> <display_name> <root_user_email>
125111
# Example:
126-
deno task tenants create favor "Favor Church" admin@example.com
112+
deno task tenants create example "Example Church" admin@example.com
127113
```
128114

129115
This will:
@@ -132,8 +118,3 @@ This will:
132118
- Insert a tenant record in the global namespace
133119
- Link the root user to the tenant with graph edges
134120
- Apply all tenant migrations to the new namespace
135-
136-
---
137-
138-
See `docker-compose.yml` for service configuration details. The `version`
139-
attribute is no longer required or present in the Compose file.

LICENSE.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,33 @@
22

33
Copyright (c) 2025 - **We Will Craft contributors**
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
1111

1212
The above copyright notice and this permission notice shall be included in all
1313
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2221

2322
---
2423

2524
# Favicon
2625

27-
The current site favicon was generated using the following graphics from Twitter Twemoji:
26+
The current site favicon was generated using the following graphics from Twitter
27+
Twemoji:
2828

2929
- Graphics Title: 1f525.svg
30-
- Graphics Author: Copyright 2020 Twitter, Inc and other contributors (https://github.com/twitter/twemoji)
31-
- Graphics Source: https://github.com/twitter/twemoji/blob/master/assets/svg/1f525.svg
30+
- Graphics Author: Copyright 2020 Twitter, Inc and other contributors
31+
(https://github.com/twitter/twemoji)
32+
- Graphics Source:
33+
https://github.com/twitter/twemoji/blob/master/assets/svg/1f525.svg
3234
- Graphics License: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,41 @@ Everything you need to shepherd your church.
66

77
## Development
88

9+
If you have all the dependencies installed, you can start the development server
10+
by running:
11+
912
```bash
1013
deno task start
1114
```
1215

16+
For more details, see [DEVELOPMENT.md](DEVELOPMENT.md).
17+
1318
## Contributing
1419

1520
**Imposter syndrome disclaimer**: We want your help. No, really.
1621

17-
There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?
22+
There may be a little voice inside your head that is telling you that you're not
23+
ready to be an open source contributor; that your skills aren't nearly good
24+
enough to contribute. What could you possibly offer a project like this one?
1825

19-
We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.
26+
We assure you - the little voice in your head is wrong. If you can write code at
27+
all, you can contribute code to open source. Contributing to open source
28+
projects is a fantastic way to advance one's coding skills. Writing perfect code
29+
isn't the measure of a good developer (that would disqualify all of us!); it's
30+
trying to create something, making mistakes, and learning from those mistakes.
31+
That's how we all improve, and we are happy to help others learn.
2032

21-
Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.
33+
Being an open source contributor doesn't just mean writing code, either. You can
34+
help out by writing documentation, tests, or even giving feedback about the
35+
project (and yes - that includes giving feedback about the contribution
36+
process). Some of these contributions may be the most valuable to the project as
37+
a whole, because you're coming to the project with fresh eyes, so you can see
38+
the errors and assumptions that seasoned contributors have glossed over.
2239

23-
(Copied from [Adrienne Friend](https://github.com/adriennefriend/imposter-syndrome-disclaimer))
40+
(Copied from
41+
[Adrienne Friend](https://github.com/adriennefriend/imposter-syndrome-disclaimer))
2442

2543
## License
2644

27-
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for more details.
45+
This project is licensed under the MIT License - see the
46+
[LICENSE.md](LICENSE.md) file for more details.

0 commit comments

Comments
 (0)