https://github.com/codingki/cosmos-frontend
https://github.com/codingki/cosmos-frontend
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codingki/cosmos-frontend
- Owner: codingki
- License: mit
- Created: 2022-09-26T21:59:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-26T22:01:10.000Z (over 3 years ago)
- Last Synced: 2025-06-14T19:09:07.685Z (8 months ago)
- Language: TypeScript
- Homepage: cosmos-frontend-omega.vercel.app
- Size: 426 KB
- Stars: 4
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Strangestarter
[Next.js](https://nextjs.org) + [Chakra UI](https://chakra-ui.com) + [Turborepo](https://turborepo.org) boilerplate for [Strangelove Ventures](https://www.strangelove.ventures/)' projects 🐲
---
**Table of contents**
- [Features](#features)
- [Using template](#using-template)
- [Setup repository](#setup-repository)
- [Scripts](#scripts)
- [GitHub Workflows](#github-workflows)
- [Directory structure](#directory-structure)
- [Notes](#notes)
- [References](#references)
- [License](#license)
---
## Features
- pnpm as default package manager
- Monorepo structure
- Flat structure inside `website/` directory
- Integrated git hooks with [`husky`](https://github.com/typicode/husky) and [`lint-staged`](https://github.com/okonet/lint-staged)
- Premade [issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) and [pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)
- Lint on latest push via [GitHub Actions](https://docs.github.com/en/actions)
## Using template
**via GitHub templates**
- Click ["Use this template"](https://github.com/strangelove-ventures/strangestarter) on this project's GitHub page
- [Or click here to create a GitHub repository based on this template](https://github.com/strangelove-ventures/strangestarter/generate)
**via CLI using degit**
```console
$ npx degit strangelove-ventures/strangestarter new-project
$ cd new-project
```
## Setup repository
- Install dependencies by running `pnpm install`
- Update website information in `website/config/favicons.json` and `website/config/metadata.json`
- Change website icon and social image in `website/public/icon.png` and `website/public/social.png`
- Generate favicons assets by running `pnpm website favicons`
## Scripts
- `pnpm build` - build website
- `pnpm dev` - run website dev instance
- `PORT=12345 pnpm dev` - run website dev instance on custom port (non-windows, for windows use [`cross-env`](https://github.com/kentcdodds/cross-env))
- `pnpm website tokens` - generate Chakra UI [theme token typings](https://chakra-ui.com/docs/styled-system/theming/advanced#theme-typings)
- `pnpm website [...args]` - run website scoped commands
## GitHub Workflows
- Lint on latest push ([view workflow schema](./.github/workflows/lint.yml))
- Manually trigger upgrade dependencies ([view workflow schema](./.github/workflows/dependencies.yml))
## Directory structure
```sh
├── packages/ # local packages
├── patches/ # package patches
└── website/ # main website entrypoint
├── config/ # various configuration files
├── constants/ # hardcoded constants and variables
├── hooks/ # custom react hooks
├── lib/ # 3rd party imports/exports (mdx, prisma, etc.)
├── pages/ # main next.js pages
├── public/ # static assets
│ └── assets/ # favicons assets
├── scripts/ # runnable scripts
├── store/ # application state providers/stores
├── styles/ # stylesheets and theme definitions
├── ui/ # components directory
└── utils/ # various utility declarations
```
## Notes
- Make sure the root directory is `website/` and not `/` ([read more](https://vercel.com/docs/concepts/git/monorepos#step-3:-set-the-root-directory))
## References
- https://chakra-ui.com/docs
- https://nextjs.org/docs
- https://pnpm.io
- https://turborepo.org/docs
- https://vercel.com/docs
## License
[MIT License, Copyright (c) 2022 Strangelove Ventures](./LICENSE)