41 lines
791 B
Markdown
41 lines
791 B
Markdown
|
# (ALPHA) Grant.io Mono Repo
|
||
|
|
||
|
This is a collection of the various services and components that make up [Grant.io](http://grant.io).
|
||
|
|
||
|
[Grant.io](http://grant.io) is under heavy development, and is not considered stable. Use at your own risk!
|
||
|
|
||
|
### Setup
|
||
|
__________________
|
||
|
|
||
|
##### Docker
|
||
|
To get setup quickly, simply use docker-compose to spin up the necessary services
|
||
|
|
||
|
TBD
|
||
|
|
||
|
|
||
|
##### Locally
|
||
|
Alternatively, run the backend and front-end services locally.
|
||
|
|
||
|
Instructions for each respective component can be found in:
|
||
|
|
||
|
- `/backend/README.md`
|
||
|
|
||
|
- `/frontend/README.md`
|
||
|
|
||
|
We currently only offer instructions for unix based systems. Windows may or may not be compatible.
|
||
|
|
||
|
|
||
|
### Testing
|
||
|
To run tests across all components simultaneously, use the following command
|
||
|
|
||
|
TBD
|
||
|
|
||
|
|
||
|
### Deployment
|
||
|
TBD
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|