Backend

Made with Node.js, Express, Prisma, written in Typescript.

Frontend

Made with MUI's components, React and create-react-app.

Contributing

Fork this project
Make sure your NodeJS and yarn versions are up to date
If you are using Windows, make sure to use Git Bash as your terminal
Setup your local Postgres databases (labrute + etwin)
Make sure to initialize your etwin database by running yarn etwin db create
Copy .env.sample to .env and adapt the variables
Copy etwin.toml.example to etwin.toml and adapt the variables
Install dependencies: yarn install (This should also setup your database from the schema.prisma file and the migrations)
Start the server, client and etwin local server with yarn dev
Commit and push your changes
Create a pull request to merge your fork into main

How to sync your database with your new Prisma schema

Run yarn db:sync:dev

How to seed your database

Edit server/src/seed.ts
Run yarn db:seed

Deployment

This project should deploy successfully as-is on Heroku

Set the environment variables
Install dependencies: npm ci (This should also compile and built everything needed)
Sync your database with yarn db:sync:prod
Start the server with yarn start

Documentation

Every

Component
Method
Callback

Should have a corresponding documentation.

File Structure

├── client
│	├── build    			# Compiled frontend
│	├── public
│	│	├── i18n			# Folder containing all the translations
│	│	└── ...      		# Any other static file
│	└── src
│		├── components 		# Reusable components
│		├── hooks     		# React hooks
│		├── layouts    		# Layouts
│		├── theme     		# Theme variables
│		├── utils       	# Utility functions
│		└── views       	# Views
├── core 					# Shared ressourcs for both front and back end
│   ├── src              
├── prisma 					# Prisma types definitions for both front and back end
│   ├── src              
└── server 					# Back end
    ├── prisma              # DB
	└── src
	    ├── controllers     # Controllers
 	  	├── utils       	# Utility functions
	    └── ...

License

avandal/labrute

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages