Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.61 KB

README.md

File metadata and controls

60 lines (38 loc) · 2.61 KB
Raw

About

The Ladderly Ecosystem is a community, a set of tools, and an educational program designed to help individuals learn to code and accelerate tech career progression. Check out these other repos for more information:

  1. ladderly-slides
  2. rect
  3. redyellowgreen

Getting Started

First, review docs/SETUP.md.

Then, install, seed, and run your app in the development mode.

npm i
npm run seed
npm run dev

Open http://localhost:3000 with your browser to see the result.

Updating Checklists

Just change the seed data and reseed with npm run seed

Recommended Tools

The extensions listed in ./.vscode/extensions.json are recommended.

Environment Variables

Ensure the .env.local file has required environment variables:

DATABASE_URL=postgresql://<YOUR_DB_USERNAME>@localhost:5432/ladderly-3

Ensure the .env.test.local file has required environment variables:

DATABASE_URL=postgresql://<YOUR_DB_USERNAME>@localhost:5432/ladderly-3_test

Tests

Runs your tests using Jest.

yarn test

Blitz comes with a test setup using Vitest and react-testing-library.

Built With

  1. Blitz.js
  2. ESLint: It lints your code: searches for bad practices and tell you about it. You can customize it via the .eslintrc.js, and you can install (or even write) plugins to have it the way you like it. It already comes with the blitz config, but you can remove it safely. Learn More.
  3. Husky: It adds githooks, little pieces of code that get executed when certain Git events are triggerd. For example, pre-commit is triggered just before a commit is created. You can see the current hooks inside .husky/. If are having problems commiting and pushing, check out ther troubleshooting guide. Learn More.
  4. Prettier: It formats your code to look the same everywhere. You can configure it via the .prettierrc file. The .prettierignore contains the files that should be ignored by Prettier; useful when you have large files or when you want to keep a custom formatting. Learn More.