Developer docs update (#487)

* Add .nvmrc file to longclaw/client to keep us all on the same version of node

It's also inline with the version of node that is used in the github actions workflow

* Adding some further documentation to the README.md

It should help people to understand the current status of the project and
how to get started with development.

* Let github actions run on all branches
pull/488/head
Nick Moreton 2023-07-10 10:53:55 +01:00 zatwierdzone przez GitHub
rodzic 33f02445ef
commit 7d4c22ca64
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
3 zmienionych plików z 39 dodań i 8 usunięć

Wyświetl plik

@ -2,9 +2,6 @@ name: Tests
on:
push:
branches:
- main
pull_request:
concurrency:

Wyświetl plik

@ -16,6 +16,22 @@ Checkout the [documentation](https://longclawshop.github.io/longclaw/)
![Image of the dashboard](docs/assets/dashboard.png)
## Project Status
We are working to upgrade the package for the latest versions of Django and Wagtail. While doing this we may need to change the way the package is structured as well as making breaking changes to the code. If you want to use Longclaw in a project, please use the latest release (1.0.2) until we have finished the upgrade.
### Currently supported versions
We are currently running the tests against the following versions of Python, Django and Wagtail.
- Django >= 2.2, < 3.1
- Wagtail >= 2.11, < 2.14
- Python >= 3.7, < 3.10
### Developers
If you are interested in working on this project, please use the [Development setup](#development-setup) instructions below to get started.
## Quickstart
Install Longclaw:
@ -61,11 +77,11 @@ python manage.py runserver
## Development setup
Work in progress!
### Work in progress
This is a brief guide to setting up a development environment for Longclaw.
The following instructions are for setting up a development environment for Longclaw while we work on the upgrade. If you want to use Longclaw in a project, please use the latest release (1.0.2) until we have finished the upgrade.
Create a virtualenv and install the requirements
#### Create a virtualenv and install the requirements
```bash
python3 -m venv venv
@ -73,13 +89,30 @@ source venv/bin/activate
pip install -e ".[testing]"
```
Run the tests
#### Install and build the frontend
The frontend is built using node and webpack. The version of node required is v12 (LTS). We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage node versions.
```bash
cd longclaw/client
```
Optional: If you are using nvm, you can run `nvm use` to set the correct version of node.
Install the dependencies and build the frontend
```bash
npm install --no-save
npm run build
```
#### Run the tests
```bash
make test
```
Run the tests with TOX
#### Run the tests with TOX
```bash
make test-all

Wyświetl plik

@ -0,0 +1 @@
12