A website to track notes, habits and become a better person.
This is a monorepo of the frontend and backend for the BuildUp web app. It uses yarn for package management with the node-modules strategy and without zero installs. .yarn is commited so there is no need to manually install yarn or the used plugins, they are already part of the project.
Both of the codebases use Typescript, ESLint, and Prettier. Most commands should be run through the top level package, a few commands must be run using yarn workspace foreach. For more information on how to work with yarn workspaces, see https://yarnpkg.com/features/workspaces
| Command | Description |
|---|---|
yarn |
To install all dependencies on the monorepo |
yarn dev |
To start developing on the monorepo |
yarn build |
To build the monorepo |
yarn start |
To run the project in production |
yarn workspaces focus --production |
To install dependencies in production |
yarn workspaces foreach |
To run a command in each package |
yarn workspaces foreach run lint |
To run the lint command in each package |
yarn workspaces foreach run format |
To run the format command in each package |
yarn workspaces foreach run build |
To run the build command in each package |
yarn workspace @buildup/backend docs:validate |
To validate the backend OpenAPI schema |
This is the application backend built in Express. It connects to a MongoDB instance and serves Swagger API documentation from its OpenAPI contract. More information is available on its own README.
This is a frontend built in React with Redux Toolkit for state management and querying the backend API. More information is available on its own README.
This project is licensed under the AGPL v3. For more information read the LICENSE.
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4){kind=small}