https://github.com/codex-team/notes.api
https://github.com/codex-team/notes.api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codex-team/notes.api
- Owner: codex-team
- Created: 2023-05-25T18:38:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T16:35:50.000Z (3 months ago)
- Last Synced: 2025-04-14T23:08:09.509Z (about 2 months ago)
- Language: TypeScript
- Size: 2.97 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# notes.api
## How to run
1. Install Node.js and npm
2. Install dependencies: `yarn install`
3. Create config file for local overrides: `cp app-config.yaml app-config.local.yaml`
4. Build: `yarn build`
5. Run: `yarn start`
## Configuration
Use `app-config.yaml` to configure the application.
#todo add ability to override config for local usage.
## Contributing
You can find documentation for developers and contributors in the [DEVELOPMENT.md](./DEVELOPMENT.md) file.
You can find documentation for a production deploy in the [DEPLOYMENT.md](./DEPLOYMENT.md) file.