Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dogstudio/dogstudio-next-starter

Opinionated Next.js starter by Dogstudio
https://github.com/dogstudio/dogstudio-next-starter

next next-starter nextjs react reactjs starter starter-kit

Last synced: 3 months ago
JSON representation

Opinionated Next.js starter by Dogstudio

Awesome Lists containing this project

README

        

## Dogstudio Next Starter

The repository has all the features needed to build blazing-fast experience.

- Next 13
- Prettier
- SCSS/SASS

## Prerequisites

- [Node.js - LTS](https://nodejs.org/en/download/)

## Getting Started

```bash
git clone [email protected]:Dogstudio/dogstudio-next-starter.git my-new-app
```

```bash
cd my-new-app
cp .env.example .env.local
```

```bash
npm i
npm run dev
```

## Documentation

We recommend the following documentations to master the stack:

- [React](https://reactjs.org/docs/getting-started.html)
- [Next.js](https://nextjs.org/docs/getting-started)
- [CSS Modules](https://github.com/css-modules/css-modules)
- [Atomic Design Pattern](https://atomicdesign.bradfrost.com/table-of-contents/)

## References

```bash
# Run Next.js in development-mode with a local server.
# Visit http://localhost:3000 to see your application running.
npm run dev

# Run Next.js in production-mode and creates a production build.
npm run build

# Run Next.js in production-mode with a local server.
# Visit http://localhost:3000 to see your production build.
npm run start

# Run Next.js linter
npm run lint

# Upgrade the dependencies and devDependencies with interactive mode
# See: https://www.npmjs.com/package/npm-check-updates
npm run upgrade
```

## Example

An example is available on the `demo` branch to test all the features included in the repository:

```bash
git checkout demo
```

```bash
npm i
npm run dev
```

## Contributing

Please submit issues, pull requests or [contact us]([email protected]). We are open to all kind of contributions.

## License

The `dogstudio-next-starter` repository is [MIT licensed](/LICENSE.md).