Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 1.11 KB

README.md

File metadata and controls

50 lines (39 loc) · 1.11 KB
Raw

Welcome to Forge 42 base-stack

This is a base-stack for Forge 42 projects. This stack is a starting point for all Forge 42 stacks with more advanced features. This is an ESM Vite stack with Remix.run.

It includes a basic setup for a project with Remix.run and:

  • TypeScript
  • TailwindCSS
  • Vite
  • Vitest (unit tests)
  • Scripting
  • ESLint
  • i18n support
  • Icon generator
  • Husky hooks
  • remix-development-tools + plugins

How to use

  1. Initialize the repository with our CLI:
npx f42 init -t base-stack -o ./your-project-name-here
  1. Install the dependencies:
npm install

  1. Read through the README.md files in the project to understand our decisions.

  2. Run the cleanup script:

npm run cleanup

This will remove everything in the project related to the base-stack like README.md etc. This is the first thing you should run after initializing the project. After it is run it will remove itself from the package.json.

  1. Start the development server:
npm run dev
  1. Happy coding!