Remix Barebones Stack
npx create-remix --template dev-xo/barebones-stack
A solid create-remix app, that follows community guidelines and applies best practices into a clean, batteries included template.
💿
Features
This Stack has been created with two main purposes: simplicity and solidity. Aiming for those who loves to build their stuff from the ground, with a solid and well tested template, to start coding right away.
- Fly app Deployment with Docker
- Production-Ready with SQLite Database
- Healthcheck endpoint for Fly backups region fallbacks
- GitHub Actions for Deploy on merge to production and staging environments.
- Database ORM with Prisma
- Styling with Tailwind.css + Tailwind Prettier-Plugin
- End-to-end testing with Cypress
- Unit testing with Vitest and Testing Library
- Local third party request mocking with MSW
- Linting with ESLint
- Code formatting with Prettier
- Static Types with TypeScript
- Support for Javascript developers with continuous updates over time.
We've got a
🐘
PostgreSQL version also.
Would you like to change something? Fork it, change it, and use npx create-remix --template your/repo!
Make it your own. Learn more about Remix Stacks.
🔋
Quickstart
# Initialize the following template into your workspace:
npx create-remix --template dev-xo/barebones-stack
# Seed database: (If you just generated this project, this step has been done for you.)
npm run setup
# Start dev server:
npm run dev
Done! This starts your app in development mode, rebuilding assets on file changes.
The database seed script creates a welcome message that will let you know, database is up and running.
🚀
Deployment
This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.
Prior to your first deployment, you'll need to do a few things:
-
Sign up and log in to Fly:
fly auth signup
Note: If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run
fly auth whoamiand ensure the email matches the Fly account signed into the browser.
- Create two apps on Fly, one for staging and one for production:
fly apps create barebones-stack
fly apps create barebones-stack-staging
Note: Make sure this name matches the
appset in yourfly.tomlfile. Otherwise, you will not be able to deploy.
- Initialize Git:
git init
- Create a new GitHub Repository, and then add it as the remote for your project. Do not push your app yet!
git remote add origin <ORIGIN_URL>
-
Add a
FLY_API_TOKENto your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the nameFLY_API_TOKEN. -
Add a
SESSION_SECRETto your fly app secrets, to do this you can run the following commands:
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app barebones-stack
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app barebones-stack-staging
Note: If you don't have openssl installed, you can also use 1password to generate a random secret, just replace
$(openssl rand -hex 32)with the generated secret.
- Create a persistent volume for the sqlite database for both your staging and production environments. Run the following:
fly volumes create data --size 1 --app barebones-stack
fly volumes create data --size 1 --app barebones-stack-staging
Now that everything is set up you can commit and push your changes to your repo. Every commit to your main branch will trigger a deployment to your production environment, and every commit to your dev branch will trigger a deployment to your staging environment.
Connecting to your database
The sqlite database lives at /data/sqlite.db in your deployed application. You can connect to the live database by running fly ssh console -C database-cli.
Getting Help with Deployment
If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to the Fly support community. They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions.
⚙️
GitHub Actions
We use GitHub Actions for continuous integration and deployment.
Anything that gets into the main branch will be deployed to production after running tests / build / etc.
Anything in the dev branch will be deployed to staging.
🧪
Testing
Cypress
We use Cypress for our End-to-End tests in this project. You'll find those in the cypress directory. As you make changes, add to an existing file or create a new file in the cypress/e2e directory to test your changes.
We use @testing-library/cypress for selecting elements on the page semantically.
To run these tests in development, run npm run test:e2e:dev which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.
Vitest
For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.
Type Checking
This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run npm run typecheck.
Linting
This project uses ESLint for linting. That is configured in .eslintrc.js.
Formatting
We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a npm run format script you can run to format all files in the project.
⭐
Support
Feel free to star the project if you found it useful.
It will help us to keep updating and working on this, other Remix projects. Thanks!
️Acknowledgments
Some of the cool features that are implemented in the template are from Indie Stack
Also a big shout out to @MichaelDeBoey.
He's doing an amazing job on remix.init folders and so on!
25 Dec 7, 2022
18 Oct 31, 2022
9 Mar 25, 2022
141 Jan 2, 2023
688 Dec 30, 2022
61 Dec 22, 2022
6 Nov 25, 2022
8 Dec 8, 2022
6 Nov 20, 2022
2 Jan 21, 2022
192 Jan 2, 2023
3 Oct 11, 2022
157 Jan 7, 2023
56 Dec 22, 2022
33 Dec 29, 2022
4 Dec 15, 2022
6 Jul 9, 2022
3 Nov 27, 2022