https://github.com/hellomouse/hellomouse-apps-api
Backend API for random hellomouse apps
https://github.com/hellomouse/hellomouse-apps-api
Last synced: over 1 year ago
JSON representation
Backend API for random hellomouse apps
- Host: GitHub
- URL: https://github.com/hellomouse/hellomouse-apps-api
- Owner: hellomouse
- License: mit
- Created: 2023-07-22T06:32:56.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-25T04:23:56.000Z (about 2 years ago)
- Last Synced: 2025-01-10T20:15:53.125Z (over 1 year ago)
- Language: Rust
- Size: 154 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hellomouse Apps API
A backend for various hellomouse apps written in Rust. Current list:
1. **Hellomouse Board:** A quick note/pinboard for storing tidbits of info
## Getting Started:
First, rename `config.toml.example` to `config.toml` and fill in the arguments. A Postgres DB is required to be setup and accessible, and the user should have the CREATE permission.
To run a debug build:
```
cargo run --bin server
```
### Adding new users:
```
cargo build --bin user --release
./target/release/user help
```
Then run the user executable for a list of commands.
### Tests:
These tests require the env variables `TEST_API_USER` and `TEST_API_PASSWORD` (which store a valid login for the site) (you will need to create a user first manually in the DB in the table `users`) and have the API server running and accessible over localhost.
To install test dependencies:
```
pip3 install -r requirements.txt
```
To run tests:
```
cd tests
python3 -m unittest discover
```
## License
See `LICENSE.md`