Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strvcom/template-frontend-next
STRV template repository for bootstrapping Next.js projects
https://github.com/strvcom/template-frontend-next
nextjs nextjs-template react strv styled-components typescript
Last synced: about 1 month ago
JSON representation
STRV template repository for bootstrapping Next.js projects
- Host: GitHub
- URL: https://github.com/strvcom/template-frontend-next
- Owner: strvcom
- Created: 2019-06-10T08:41:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-05T17:03:18.000Z (about 3 years ago)
- Last Synced: 2024-04-14T06:31:39.350Z (8 months ago)
- Topics: nextjs, nextjs-template, react, strv, styled-components, typescript
- Language: TypeScript
- Homepage:
- Size: 534 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PROJECT_NAME
## Get Started
1. To create a project based on this template click on the `Use this template` button
2. Find and Replace `PROJECT_NAME` placeholder with the real project name
3. Delete libraries which do not satisfy project needs
4. Delete this section from `README`
5. To cover your tracks and incorporate the changes to the project's `Initial commit`, run these commands:
```sh
git commit -a --amend
git push -f origin master
```
---
## Documentation
Project is based on `Next.js`, a production-ready React Framework. Check out the [documentation](https://nextjs.org/docs) for more information.
## Prerequisites
- `node`
- `yarn`
## Usage
**Firstly, install all necessary dependencies:**
```sh
yarn install
```
**To start a development server:**
```sh
yarn dev
```
**To build the app for production:**
```sh
yarn build
yarn start
```
**To run tests:**
```sh
yarn test
```
## Deployment
> TODO: add info after setup
## What's Inside
- React Framework
- [Next.js](https://nextjs.org)
- Type-checking
- [TypeScript](https://www.typescriptlang.org/docs/home.html)
- Styling
- [styled-components](https://www.styled-components.com/docs)
- Code quality tools
- Prettier
- ESLint
- stylelint
- git hooks