lucianonooijen / genesis

Genesis project template and scaffolding

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Genesis

Project directory structure

  • /app: mobile application
    • /packages: Typescript packages used throughout the project
      • /api: the api sdk connecting the app to the server
      • /entities: entities for Typescript code
  • /server: backend application (api exposed)
  • /docs: documentation for the application as a whole
  • /bin: scripts for project-wide actions
  • /.gitlab: GitLab related configurations

Requirements

  • NodeJS v16 LTS, with Yarn installed globally
  • Android Studio for running the Android app
  • XCode for running the iOS app
  • Yarn 1.13.0+ (npm i -g yarn@latest)
  • Golang 1.17+

Development

Instructions for running the back-end can be found in /server/README.md.

For the app you can cd app and then after running yarn you can get a list of all available commands by running `yarn run .

License

The project is licensed under GPL-3.0, except for the mobile application, which is Apache-2.0 licensed

About

Genesis project template and scaffolding

License:GNU General Public License v3.0


Languages

Language:Go 50.1%Language:TypeScript 38.0%Language:JavaScript 4.2%Language:Objective-C 2.4%Language:Java 2.2%Language:Makefile 0.9%Language:Dockerfile 0.7%Language:Shell 0.6%Language:PLpgSQL 0.5%Language:Ruby 0.3%Language:Starlark 0.2%