789879a9cc
We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
114 lines
2.9 KiB
Markdown
114 lines
2.9 KiB
Markdown
# Impress
|
|
|
|
Impress is a web application for real-time collaborative text editing with user and role based access rights.
|
|
Features include :
|
|
- User authentication through OIDC
|
|
- BlocNote.js text editing experience (markdown support, dynamic conversion, block structure, slash commands for block creation)
|
|
- Document export to pdf and docx from predefined templates
|
|
- Granular document permissions
|
|
- Public link sharing
|
|
- Offline mode
|
|
|
|
Impress is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/) and [BlocNote.js](https://www.blocknotejs.org/)
|
|
|
|
## Getting started
|
|
|
|
### Prerequisite
|
|
|
|
Make sure you have a recent version of Docker and [Docker
|
|
Compose](https://docs.docker.com/compose/install) installed on your laptop:
|
|
|
|
```bash
|
|
$ docker -v
|
|
Docker version 20.10.2, build 2291f61
|
|
|
|
$ docker compose -v
|
|
docker compose version 1.27.4, build 40524192
|
|
```
|
|
|
|
> ⚠️ You may need to run the following commands with `sudo` but this can be
|
|
> avoided by assigning your user to the `docker` group.
|
|
|
|
### Project bootstrap
|
|
|
|
The easiest way to start working on the project is to use GNU Make:
|
|
|
|
```bash
|
|
$ make bootstrap FLUSH_ARGS='--no-input'
|
|
```
|
|
|
|
This command builds the `app` container, installs dependencies, performs
|
|
database migrations and compile translations. It's a good idea to use this
|
|
command each time you are pulling code from the project repository to avoid
|
|
dependency-releated or migration-releated issues.
|
|
|
|
Your Docker services should now be up and running 🎉
|
|
|
|
You can access to the project by going to http://localhost:3000.
|
|
You will be prompted to log in, the default credentials are:
|
|
```bash
|
|
username: impress
|
|
password: impress
|
|
```
|
|
|
|
📝 Note that if you need to run them afterwards, you can use the eponym Make rule:
|
|
|
|
```bash
|
|
$ make run-with-frontend
|
|
```
|
|
|
|
---
|
|
|
|
⚠️ For the frontend developper, it is often better to run the frontend in development mode locally.
|
|
To do so, install the frontend dependencies with the following command:
|
|
|
|
```bash
|
|
$ make frontend-install
|
|
```
|
|
And run the frontend locally in development mode with the following command:
|
|
|
|
```bash
|
|
$ make run-frontend-development
|
|
```
|
|
|
|
To start all the services, except the frontend container, you can use the following command:
|
|
|
|
```bash
|
|
$ make run
|
|
```
|
|
|
|
---
|
|
|
|
### Adding content
|
|
|
|
You can create a basic demo site by running:
|
|
|
|
$ make demo
|
|
|
|
Finally, you can check all available Make rules using:
|
|
|
|
```bash
|
|
$ make help
|
|
```
|
|
|
|
### Django admin
|
|
|
|
You can access the Django admin site at
|
|
[http://localhost:8071/admin](http://localhost:8071/admin).
|
|
|
|
You first need to create a superuser account:
|
|
|
|
```bash
|
|
$ make superuser
|
|
```
|
|
|
|
## Contributing
|
|
|
|
This project is intended to be community-driven, so please, do not hesitate to
|
|
get in touch if you have any question related to our implementation or design
|
|
decisions.
|
|
|
|
## License
|
|
|
|
This work is released under the MIT License (see [LICENSE](./LICENSE)).
|