8b015a3850
* refactor: swagger docs into a folder * added scripts for the swaggger tasks * check version and fmt * CI * formatted swag comments * using custom delims * revert custom delims * swag 1.16.1 * update swagger docs * avoid make swagger output * swagger check * test * swag-fmt * swagger run * gofmt * avoid swag-fmt check for now due to inconsistencies with gofmt * re-enabled by using go fmt afterwards * use newer swag in CI * add gopath to path * using go binary instead of unset env * alternative * correct swag version * formatted * formatted * correct go fmt command * make swagger * swagger-check -> swag-check * run swag-check on lint
1.9 KiB
Contribute
Running the server locally
To run the current development server with the defaults you can run the following command:
make serve
If you want to run the refactored server, you can run the following command:
make run-server
ℹ️ Note: For more information into what the refactored server means, please check this issue: https://github.com/go-shiori/shiori/issues/640
Updating the API documentation
ℹ️ Note: This only applies for the Rest API documentation under the
internal/httpfolder, not the one underinternal/webserver.
If you make any changes to the Rest API endpoints, you need to update the swagger documentation. In order to do that, you need to have installed swag.
Then, run the following command:
make swagger
Lint the code
In order to lint the code, you need to have installed golangci-lint and swag.
After that, run the following command:
make lint
If any errors are found please fix them before submitting your PR.
Running tests
In order to run the test suite, you need to have running a local instance of MariaDB and PostgreSQL. If you have docker, you can do this by running the following command with the compose file provided:
docker-compose up -d mariadb postgres
After that, provide the SHIORI_TEST_PG_URL and SHIORI_TEST_MYSQL_URL environment variables with the connection string to the databases:
SHIORI_TEST_PG_URL=postgres://shiori:shiori@127.0.0.1:5432/shiori?sslmode=disable
SHIORI_TEST_MYSQL_URL=shiori:shiori@tcp(127.0.0.1:3306)/shiori
Finally, run the tests with the following command:
make unittest