This is a Blitz.js app.
Run your app in the development mode.
We use PlanetScale for our production/dev database. You will need to download pscale
and be added to the team. Check out the Environment Variables section to set the correct env vars.
After logging in through the cli, run yarn db:start
to connect to the database.
Then you can start the development server.
blitz dev
Open http://localhost:3000 with your browser to see the result.
Ensure the .env.local
file has required environment variables:
DATABASE_URL="mysql://[email protected]:3309/crossfit-social-us-east"
Ensure the .env.test.local
file has required environment variables:
Create MySQL db locally for running tests:
brew install mysql
mysql_secure_installation
- enter new password (i use
password
) mysql -uroot -p
create database crossfit_social_test;
# .env.test.local
DATABASE_URL="mysql://root:[email protected]:3306/crossfit_social_test"
Runs your tests using Jest.
yarn test
Blitz comes with a test setup using Jest and react-testing-library.
Blitz comes with a powerful CLI that is designed to make development easy and fast. You can install it with npm i -g blitz
blitz [COMMAND]
dev Start a development server
build Create a production build
start Start a production server
export Export your Blitz app as a static application
prisma Run prisma commands
generate Generate new files for your Blitz project
console Run the Blitz console REPL
install Install a recipe
help Display help for blitz
test Run project tests
You can read more about it on the CLI Overview documentation.
PlanetScale doesnt allow Prisma to create databases, so we need a dedicated branch. I set up the shadow
branch for this purpose.
You'll need to add SHADOW_DATABASE_URL
to your .env.local
:
SHADOW_DATABASE_URL="mysql://[email protected]:3310/crossfit-social-us-east/shadow"
Then you can connect to it:
yarn db:start:shadow
Now you can run yarn db:migrate
after making changes to db/schema.prisma
.
These files are:
-
The
app/
folder is a container for most of your project. This is where you’ll put any pages or API routes. -
db/
is where your database configuration goes. If you’re writing models or checking migrations, this is where to go. -
public/
is a folder where you will put any static assets. If you have images, files, or videos which you want to use in your app, this is where to put them. -
integrations/
is a folder to put all third-party integrations like with Stripe, Sentry, etc. -
test/
is a folder where you can put test utilities and integration tests. -
package.json
contains information about your dependencies and devDependencies. If you’re using a tool likenpm
oryarn
, you won’t have to worry about this much. -
tsconfig.json
is our recommended setup for TypeScript. -
.babel.config.js
,.eslintrc.js
,.env
, etc. ("dotfiles") are configuration files for various bits of JavaScript tooling. -
blitz.config.ts
is for advanced custom configuration of Blitz. Here you can learn how to use it. -
jest.config.js
contains config for Jest tests. You can customize it if needed.
You can read more about it in the File Structure section of the documentation.
Blitz comes with a set of tools that corrects and formats your code, facilitating its future maintenance. You can modify their options and even uninstall them.
- 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 theblitz
config, but you can remove it safely. Learn More. - 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. - 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.
Read the Blitz.js Documentation to learn more.
The Blitz community is warm, safe, diverse, inclusive, and fun! Feel free to reach out to us in any of our communication channels.