Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basementstudio/app-dir-example
App dir example made with our next-typescript starter.
https://github.com/basementstudio/app-dir-example
Last synced: about 2 months ago
JSON representation
App dir example made with our next-typescript starter.
- Host: GitHub
- URL: https://github.com/basementstudio/app-dir-example
- Owner: basementstudio
- Created: 2023-05-17T12:48:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-24T08:36:37.000Z (about 1 year ago)
- Last Synced: 2024-04-24T04:53:51.555Z (8 months ago)
- Language: CSS
- Homepage: https://app-dir-example.vercel.app
- Size: 7.6 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# next-typescript
The objective of this boilerplate is to set up everything the developer will need (in terms of configuration) to start a next + typescript project. Eslint, prettier and husky are configured to work independent of the user's IDE configuration (as long as it's vscode).
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fbasementstudio%2Fnext-typescript&env=NEXT_PUBLIC_SITE_URL&envDescription=e.g%3A%20https%3A%2F%2Fproject-name.vercel.app)
## Featured Aspects of the Stack
- [TypeScript](https://www.typescriptlang.org/)
- [Next.js](https://nextjs.org/)
## Things to Note
- It comes with Inter (it's better to host fonts here rather than getting them from google fonts).
- Pages, components, etc... are located under `/src`. If you are changing this, be sure to also update `tsconfig.json`'s `baseUrl`.
## Development
1. Install yarn:
```
npm install -g yarn
```
2. Install the dependencies with:
```
yarn
```
3. Start developing and watch for code changes:
```
yarn dev
```
## Important Things to Do
- [ ] Check out `.env.example` for required environment variables to run the project.
- [ ] Add favicons. (Re)Place in `./public`: _32x32_ `favicon.ico`, _perfect square_ `favicon.svg` and `favicon-dark.svg` (_dark theme_), _512x512_ `icon-512.png`, _192x192_ `icon-192.png`, _180x180_ `apple-touch-icon.png`. You can use something [like this](https://realfavicongenerator.net/) for some (better to use Gimp, Photoshop, or any graphics editor; read more about it [here](https://evilmartians.com/chronicles/how-to-favicon-in-2021-six-files-that-fit-most-needs)).
- [ ] Delete `console.log(basementLog)` if not wanted — it's under `_app.tsx`.
- [ ] Replace the contents of this file (`README.md`) with the contents of the `README.example.md` file — make sure to adapt it to your project's specific needs. Finally, delete the old `README.example.md` file.
---
If you find you need to make extra config to make this work more seamlessly, feel free to submit a PR suggesting your changes. Our focus is to get you up and running with the least steps and burden as possible.
---
