You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Welcome to Docs! The open source document editor where your notes can become kno
13
13
Chat on Matrix
14
14
</a> - <ahref="/docs/">
15
15
Documentation
16
-
</a> - <ahref="#getting-started">
16
+
</a> - <ahref="#getting-started-">
17
17
Getting started
18
18
</a>
19
19
</p>
@@ -60,7 +60,7 @@ $ docker compose -v
60
60
docker compose version 1.27.4, build 40524192
61
61
```
62
62
63
-
> ⚠️ You may need to run the following commands with sudo but this can be avoided by assigning your user to the `docker` group.
63
+
> ⚠️ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group.
64
64
65
65
**Project bootstrap**
66
66
The easiest way to start working on the project is to use GNU Make:
@@ -71,17 +71,16 @@ $ make bootstrap FLUSH_ARGS='--no-input'
71
71
72
72
This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this
73
73
74
-
command each time you are pulling code from the project repository to avoid dependency-releated or migration-releated issues.
74
+
command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
75
75
76
76
Your Docker services should now be up and running 🎉
77
77
78
78
You can access to the project by going to <http://localhost:3000>.
79
79
80
80
You will be prompted to log in, the default credentials are:
81
81
82
-
```shellscript
82
+
```
83
83
username: impress
84
-
85
84
password: impress
86
85
```
87
86
@@ -172,7 +171,7 @@ docs
172
171
Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/)
173
172
174
173
### Gov ❤️ open source
175
-
Docs is the result of a joint effort lead by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)).
174
+
Docs is the result of a joint effort led by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)).
176
175
177
176
We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).
0 commit comments