https://github.com/nikelborm/project-boilerplate

https://github.com/nikelborm/project-boilerplate

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/nikelborm/project-boilerplate
• Owner: nikelborm
• Created: 2022-05-04T12:34:27.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-20T07:33:26.000Z (over 1 year ago)
• Last Synced: 2024-04-06T09:35:27.035Z (7 months ago)
• Language: TypeScript
• Size: 3.44 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# project-boilerplate

## Requirements and initialization

If you don't have vs code, search for commands in `./project.code-workspace`

1. Install docker, docker-compose, buildx

2. Install node.js 16 with nvm. [NVM GitHub](https://github.com/nvm-sh/nvm)

3. Install yarn with `npm i -g yarn`

4. Call task in VS code: `Create new docker builder` (call only once when pulling project)

5. Call task in VS code: `Use docker builder` (call only once when pulling project)

6. Call task in VS code: `Install yarn dependencies` (call only once when pulling project)

## Development

If you plan to develop and use own fs

1. Call task in VS code for better typing support: `Mount types/shared in native fs`.

2. Call task in VS code: `Up dev`

If you want to develop inside a container

1. Call command in VS code: `Dev containers: Reopen in container`

## How to run psql

1. Call task in VS code: `psql dev`

## Endpoint to execute mock

## TODO

- [ ] password recovery|reset

- [ ] Move yarn dependencies one level higher

- [ ] Merge typescript, prettier and eslint configs and place it in project root directory

- [ ] write script for getting sql from all migrations into one .sql file which then will be fed to dbml documentation generator

- [ ] add healthcheck

- [ ] wrap mock into transaction

- [ ] update customFetch in frontend to use latest version made in tda project

- [ ] cache requests to db for user with joined all access scopes (don't forget to invalidate cache when updating user or access scopes)

- [ ] move some logic of redis commands from js to lua right into redis itself