Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/paulogdm/blog

personal PWA blog built with Next.js
https://github.com/paulogdm/blog

Last synced: about 1 month ago
JSON representation

personal PWA blog built with Next.js

Awesome Lists containing this project

README

        


Next.js 🧳


A starting point for my Nextjs Project with default config and components 🧳


## Contents

- [Installation](#Installation)
- [Get Started](#GetStarted)

## Quick Overview

```sh
degit https://github.com/casprine/backpack\#nextjs my-app
cd my-app
yarn start
```

Then open [http://localhost:3000/](http://localhost:3000/) to see your app.

When you’re ready to deploy to production, create a minified bundle with `yarn build` or `npm run build`.

## Get Started

This project scaffold is created manaully with inspiration from creat-next-app. Project is clonend with degit. Make sure you have it installed globally.

```sh
degit https://github.com/casprine/backpack\#nextjs my-app
```

### What's in my-app

degit will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure.

```
.
β”œβ”€β”€ LICENSE
β”œβ”€β”€ README.md
β”œβ”€β”€ next.config.js
β”œβ”€β”€ package.json
β”œβ”€β”€ pages
β”‚Β Β  β”œβ”€β”€ _document.js
β”‚Β Β  └── index.js
β”œβ”€β”€ server.js
β”œβ”€β”€ static
β”‚Β Β  β”œβ”€β”€ fonts
β”‚Β Β  β”‚Β Β  └── ciruclar.ttf
β”‚Β Β  └── sass
β”‚Β Β  └── index.scss
β”œβ”€β”€ todo.md
β”œβ”€β”€ utils
β”‚Β Β  β”œβ”€β”€ helpers.js
β”‚Β Β  β”œβ”€β”€ index.js
β”‚Β Β  └── localStorage.js
└── yarn.lock
```

Once the cloning is complete, enter the directory and install dependencies.

```sh
cd my-app
yarn
```

or

```sh
cd my-app
npm install
```

Once the installation is finished, you can run some commands in your project:

### `npm run start` or `yarn start`

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.

You will also see any errors in the console.

### `npm run build` or `yarn build`

Builds the app for production to the `.next` folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

### `npm run start` or `yarn start`

Starts the application in production mode.
The application should be compiled with `npm run build` first.

Now you're ready to code & deploy your app!