https://github.com/condef5/profitm8
https://github.com/condef5/profitm8
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/condef5/profitm8
- Owner: condef5
- Created: 2023-05-16T17:38:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-16T17:41:51.000Z (about 3 years ago)
- Last Synced: 2025-03-16T02:48:21.797Z (about 1 year ago)
- Language: TypeScript
- Size: 517 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Boilerplate Remix
## Typescript + React + Remix + Prisma
Comes with user authentication included
- [React](https://github.com/facebook/react)
- [Prisma](https://www.prisma.io)
- [Remix](https://github.com/remix-run/remix)
- [TypeScript](https://github.com/microsoft/TypeScript)
- [Postgres](https://github.com/postgres/postgres)
- [Chakra UI](https://github.com/chakra-ui/chakra-ui)
- [Eslint](https://github.com/eslint/eslint)
- [Prettier](https://github.com/prettier/prettier)
- [Husky](https://github.com/typicode/husky)
- [Lint staged](https://github.com/okonet/lint-staged)
- Sendgrid SMTP
- Customizable theme & Dark mode
& many more tasty treats
## Get Started
**Must have node, yarn, postgres and redis installed and setup locally**
1. `yarn install`
2. `createdb boilerplate`
3. `yarn db:migrate`
Make sure you have created a .env file in the api package with the right values, you can use .env.example as the template
We use Husky to run a couple of checks each commit (prettier, eslint & commitlint), make sure to add a
.huskyrc file to your home directory ~/.huskyrc, and add this in:
```bash
export PATH="/usr/local/bin:$PATH"
```
then run
```bash
npx husky install
```
## Development
`yarn dev`
## Production
### Mailers
- Create a Sendgrid account and set a SENDGRID_API_KEY environment variable in .env
- Create templates for each email you want to send and use the templateId in the corresponding mailer class
### Deployment
An example is deployed [here](https://boilerplate-remix.noquarter.co)
We are using Fly.io
### Extra info
- [Remix Docs](https://remix.run/docs)