Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avitorio/quickstack
QuickStack - NestJS + Expo Boilerplate for Fast Web and Mobile App Development.
https://github.com/avitorio/quickstack
docker expo graphql nestjs typescript
Last synced: about 1 month ago
JSON representation
QuickStack - NestJS + Expo Boilerplate for Fast Web and Mobile App Development.
- Host: GitHub
- URL: https://github.com/avitorio/quickstack
- Owner: avitorio
- License: mit
- Created: 2020-07-16T11:41:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T13:40:06.000Z (almost 2 years ago)
- Last Synced: 2024-11-24T18:43:40.811Z (about 2 months ago)
- Topics: docker, expo, graphql, nestjs, typescript
- Language: TypeScript
- Homepage: quickstack-git-master.andrevitorio.vercel.app
- Size: 4.66 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
QuickStack - NestJS + Expo Boilerplate for Fast Web and Mobile App Development.
Features •
Getting started •
Contributing •
License
## 🚀 Features
- NestJS;
- Expo;
- Typescript;
- GraphQL;
- PostgresSQL;
- React Native Paper;
- Handlebars for Email Templates;
- Docker;
- Authentication;
- User Registration;
- User Roles;
- Password Recovery;
- Backend Tests;
## ⚡️ Getting started
### Backend
Clone the repository and in your terminal cd into /backend.
Using Yarn:
```sh
yarn
```
Using NPM:
```sh
npm install
```
Make duplicates of the .example files in the root and /config directories and remove the .example extension.
Edit them with your credentials.
If you'd like to load the backend with Docker, run:
```sh
docker-compose up
```
Otherwise, if you have a Postgres instance running, you can run:
```sh
yarn start:dev
```
or
```sh
npm run start:dev
```
### Frontend
cd into /frontend.
Using Yarn:
```sh
yarn
```
Using NPM:
```sh
npm install
```
Once the installation is done, run:
```sh
expo start
```
## 👩🏽💻 User Roles
The boilerplate currently comes with two roles, Admins and Members.
The role of Admin is assigned to the first user to register on the system.
Subsequent users are registered as members.
There's a role guard setup on the backend for GraphQL endpoints and on the frontend
for routes. I'll be updating the Users list screen so that Admins can update users
information from the Dashboard.
## ✨ Contributing
Thanks for being interested in contributing! We’re so glad you want to help! All type of contributions are welcome, such as bug fixes, issues or feature requests.
## 📝 License
Licensed under the [MIT License](./LICENSE).