Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
keery committed Mar 15, 2021
0 parents commit 4362082
Show file tree
Hide file tree
Showing 105 changed files with 28,141 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[[source]]
url = "https://pypi.python.org/simple"
verify_ssl = true
name = "pypi"

[packages]
docker-compose = "*"

[dev-packages]

[requires]
python_version = "3.8"
278 changes: 278 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Project template

This project goal is to have a setup of yarn workspaces with the following projects

- web : a Next.js (front) + Nest.js (api) + react-admin (admin)
- mobile : a React Native app
- core : shared code with Redux stack and components

## QuickStart

requirements : pipenv

Start infrastructure :

```bash
pipenv shell
yarn
docker-compose up
```

### Web project

Start the project

```
cd web && yarn dev
```

Create fake users and projects

```
yarn console:dev fixtures
```

### Mobile project

The web and mobile apps are set up to use the shared code from [core](core/src) folder

Run from the [root](/) folder to install both mobile's and web app's dependencies

```sh
yarn install
cd mobile/ios && pod install
```

Launch mobile app (React Native)

```sh
yarn ios|android
```

Run e2e test

```sh
cd mobile && detox build
detox test
```

## Library used by those projects

- Next.js https://nextjs.org/docs/getting-started
- React-hook-form https://react-hook-form.com/
- SWR (HTTP client) https://swr.vercel.app/
- Rematch (Redux stack) https://github.com/rematch/rematch
- [Restyle](https://github.com/Shopify/restyle)
- react-native-web (sharing views between web & mobile)
- swagger-typescript-api (generate TS typing from Swagger documentation)
- Nest.js with TypeORM https://nestjs.com
- nestjs-crud for the REST API https://github.com/nestjsx/crud
- react-admin https://github.com/marmelab/react-admin

## Deployement

TODO Heroku

TODO Appcenter
16 changes: 16 additions & 0 deletions back/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[{package.json,*.yml}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false
2 changes: 2 additions & 0 deletions back/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
HOST=0.0.0.0
PORT=1337
3 changes: 3 additions & 0 deletions back/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.cache
build
**/node_modules/**
Loading

0 comments on commit 4362082

Please sign in to comment.