An online spaced-repition learning platform 📚
| Codebase | Description |
|---|---|
| app | Create React Web App |
| backend | Rails Backend |
| library | Shared frontend code |
| Branch | Description |
|---|---|
| main | Master Branch -> Production |
| develop | Develop Branch -> Staging |
| feature/* | Feature branches |
| bugfix/* | Bug fix branches |
| hotfix/* | Hotfix branches |
Git workflow
Helps keep the working tree clean 🙏🏽. Learn more here
These are handed using Github Actions. The web app is deployed to Vercel, and the backend to Heroku
Domains
| Domain | Description |
|---|---|
| guava.cards | Production Frontend |
| staging.guava.cards | Staging Frontend (Password Protected) |
| api.guava.cards | Production API |
| staging-api.guava.cards | Staging API (HTTP Basic Authentication) |
See TESTING.md
This codebase is licensed under GNU Affero General Public License v3.
What this permits you to do is:
- Use the software for commerical purposes
- Modify the software and create derivates
- Distribute original or derivate copies of the software
In doing so you must:
- Include a copyright notice (© Jesse Onolememen, Guava Cards LTD 2021. All Rights Reserved)
- Include the full text license in the modified software
- State changes made to the sofware
- Diclose your source code when you distribute, publish or serve modified or derviate versions of the software
What this does not permit you to do:
- Sublicense