avitorio / quickstack

QuickStack - NestJS + Expo Boilerplate for Fast Web and Mobile App Development.

Home Page:quickstack-git-master.andrevitorio.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

QuickStack
QuickStack - NestJS + Expo Boilerplate for Fast Web and Mobile App Development.

PRs welcome! License Follow @andrevitorio

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:

yarn

Using NPM:

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:

docker-compose up

Otherwise, if you have a Postgres instance running, you can run:

yarn start:dev

or

npm run start:dev

Frontend

cd into /frontend.

Using Yarn:

yarn

Using NPM:

npm install

Once the installation is done, run:

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.

About

QuickStack - NestJS + Expo Boilerplate for Fast Web and Mobile App Development.

quickstack-git-master.andrevitorio.vercel.app

License:MIT License


Languages

Language:TypeScript 90.1%Language:Handlebars 8.4%Language:JavaScript 1.4%Language:Shell 0.1%Language:Dockerfile 0.0%