Implementation of blindnet devkit API v1, in Scala
Documentation
•
Submit an Issue
•
Online Chat
🚀 Check out our Quick Start Guide to get started in a snap.
Use sbt to build the server JAR:
sbt assemblyThe server JAR will be available at target/scala-3.x.x/blindnet.jar.
Optionally, build the docker image:
docker build .This project uses a PostgreSQL database. Create one and then put the needed configuration options in the environment variables below. Migrations run during startup of the server, if enabled (see options below).
Required if no default value.
| Name | Description | Example | Default |
|---|---|---|---|
| BN_ENV | Environment | development, staging, production | development |
| BN_MIGRATE | Enables DB migration | yes, no | env-dependant |
| BN_DB_URI | Database URI | jdbc:postgresql://localhost/blindnet |
|
| BN_DB_USER | Database username | blindnet |
|
| BN_DB_PASSWORD | Database password | blindnet |
|
| BN_PORT | HTTP port | 80 | 8087 |
| BN_HOST | HTTP host | 0.0.0.0 | 127.0.0.1 |
| BN_AZURE_STORAGE_ACC_NAME | Azure storage account name | ||
| BN_AZURE_STORAGE_ACC_KEY | Azure storage account key | ||
| BN_AZURE_STORAGE_CONT_NAME | Azure storage container name |
Contributions of all kinds are always welcome!
If you see a bug or room for improvement in this project in particular, please open an issue or directly fork this repository to submit a Pull Request.
If you have any broader questions or suggestions, just open a simple informal DevRel Request, and we'll make sure to quickly find the best solution for you.
All community participation is subject to blindnet’s Code of Conduct.
Stay up to date with new releases and projects, learn more about how to protect your privacy and that of our users, and share projects and feedback with our team.
- Join our Slack Workspace to chat with the blindnet community and team
- Follow us on Twitter to stay up to date with the latest news
- Check out our Openness Framework and Product Management on Github to see how we operate and give us feedback.
The blindnet devkit {short-project-name} is available under MIT (and here is why).