Skip to content

Latest commit

 

History

History
133 lines (83 loc) · 5.49 KB

README.md

File metadata and controls

133 lines (83 loc) · 5.49 KB

HomeCookd

HomeCookd

Features

1. Discover Local Food Influencers and Home Cooks

Homecookd brings together a diverse community of food influencers and talented home cooks who offer a wide range of culinary specialties. From traditional family recipes to innovative fusion dishes, there's something for everyone. Browse through profiles, explore menus, and discover your new favorite chefs.

Discover

2. Place Orders with Ease

Ordering food with Homecookd is quick and convenient. Simply select your desired dishes from the available menus, customize your order with any specific preferences or dietary requirements, and proceed to checkout. You can even schedule deliveries in advance or opt for pickup if you prefer.

Order

For Cooks

Create and Post Meals

As a food influencer or home cook, you can easily create and post your meals on Homecookd. Showcase your culinary skills, provide enticing descriptions, and upload appealing pictures of your dishes. Make it easy for others to browse and order your mouthwatering creations.

Create and Post Meals

Track Your Income and Orders

Homecookd provides you with a comprehensive dashboard to track your income and orders. Gain insights into your earnings, view detailed order histories, and keep track of your performance. Stay organized and efficiently manage your culinary business with Homecookd's intuitive interface.

Track Your Income and Orders

What's in the stack

Built with Blues Stack of Remix, this app comes with:

Development

  • This step only applies if you've opted out of having the CLI install dependencies for you:

    npx remix init
  • Start the Postgres Database in Docker:

    npm run docker

    Note: The npm script will complete while Docker sets up the container in the background. Ensure that Docker has finished and your container is running before proceeding.

  • Initial setup:

    npm run setup
  • Run the first build:

    npm run build
  • Start dev server:

    npm run dev

This starts your app in development mode, rebuilding assets on file changes.

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.

We have a utility for testing authenticated features without having to go through the login flow:

cy.login();
// you are now logged in as a new user

We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:

afterEach(() => {
  cy.cleanupUser();
});

That way, we can keep your local db clean and keep your tests isolated from one another.

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.