⚠️⚠️⚠️ Deprecating this repo and moving everything to 🚝 comosus-turbo 💫

🍍 A.Comosus Client Side NextJS Application

This is a Next.js project bootstrapped with create-next-app.

🏃‍♂️ How to run this project?

First, set up the development environment

TL;DR You need to set up following environment variables.

Then you want to make sure you have downloaded all the dependencies used for this project,

yarn

Then you will need to fetch required graphql schema and generate react-query hooks with:

yarn codegen

Then you can start the app simply by:

yarn dev

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

🅱️ How to start storybook?

Alright, we have support for storybook now!

To load the storybook when you are in developmetn mode, you can run the following command to spin up a storybook server at port 6006

yarn storybook

To build a static storybook website, you can run the following command

yarn build-storybook

🧪 How to test this app?

Simple! Just run this and you are good to go!

yarn test

To run e2e test with cypress, if you have the next server spinning already, then you can just run.

yarn e2e
# cypress run

However, there's also a command that allows you to start the server and run test at once.

yarn e2e:start-server
# start-server-and-test dev 3000 cypress run

File Structure

Files are structured based on this Guide, but in a nutshell 🥜🥜.

root/
  src/ // @src/* - Convenient backup path to bubble up to src directory
    __test__
    _generated/ // @generated/* - graphql-codegen generated graphql schema
    common/ // @common/* -  Files that will be used throughout the project
      components/
        [type]/
        index
    modules/ // @modules/* - Files grouped by modules/functionalities
      [module]/
        components/
          index
        sections/
          index
    utils/ // @utils/* - All the utilities we need for this project?

    pages/ // @pages/* - Not sure why I have this but you never know 😎
    styles/

🥞 What is your tech stack?