Update README
This commit is contained in:
@@ -1,30 +0,0 @@
|
||||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
||||
@@ -1,46 +1,41 @@
|
||||
# Web 2.0 Frontend
|
||||
|
||||
Minimal starter kit with hot module replacement (HMR) for rapid development.
|
||||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
|
||||
|
||||
* **[React](https://facebook.github.io/react/)** (16.x)
|
||||
* **[Webpack](https://webpack.js.org/)** (4.x)
|
||||
* **[Typescript](https://www.typescriptlang.org/)** (2.x)
|
||||
* **[Hot Module Replacement (HMR)](https://webpack.js.org/concepts/hot-module-replacement/)** using [React Hot Loader](https://github.com/gaearon/react-hot-loader) (4.x)
|
||||
* [Babel](http://babeljs.io/) (6.x)
|
||||
* [SASS](http://sass-lang.com/)
|
||||
* [Jest](https://facebook.github.io/jest/) - Testing framework for React applications
|
||||
* Production build script
|
||||
* Image loading/minification using [Image Webpack Loader](https://github.com/tcoopman/image-webpack-loader)
|
||||
* Typescript compiling using [TS-Loader](https://webpack.js.org/guides/typescript/)
|
||||
* Code quality (linting) for Typescript and SASS/CSS.
|
||||
* **[React](https://facebook.github.io/react/)** (17.x)
|
||||
* **[Typescript](https://www.typescriptlang.org/)** (4.x)
|
||||
* **[Next.js](https://nextjs.org/)** (4.x)
|
||||
* [Testcafe](https://facebook.github.io/jest/) - E2E Testing framework
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone/download repo
|
||||
2. Install node v14
|
||||
2. Install node v14 ([`nvm`](https://github.com/nvm-sh/nvm))
|
||||
3. `npm install`
|
||||
|
||||
## Usage
|
||||
## Getting Started
|
||||
|
||||
### Development
|
||||
|
||||
`npm start`
|
||||
Run the dev-server:
|
||||
|
||||
* Build app continously (HMR enabled)
|
||||
* App served @ `http://localhost:3000`
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
### Create new component
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
`npm run plop`
|
||||
|
||||
* Create a new component interactively using plop templates
|
||||
You can start editing the website by modifying source files. The page auto-updates as you edit the file.
|
||||
|
||||
### Production
|
||||
|
||||
`npm run start-prod`
|
||||
```bash
|
||||
npm run build
|
||||
npm run start-prod
|
||||
```
|
||||
|
||||
* Build app once (HMR disabled)
|
||||
* App served @ `http://localhost:3000`
|
||||
* App served @ `http://localhost:80`
|
||||
|
||||
---
|
||||
|
||||
@@ -48,22 +43,25 @@ Minimal starter kit with hot module replacement (HMR) for rapid development.
|
||||
|
||||
Command | Description
|
||||
--- | ---
|
||||
`npm run start-dev` | Build app continously (HMR enabled) and serve @ `http://localhost:3000`
|
||||
`npm run start-prod` | Build app once (HMR disabled) and serve @ `http://localhost:3000`
|
||||
`npm run build` | Build app to `/dist/`
|
||||
`npm run test` | Run e2e and unit tests
|
||||
`npm run test:unit` | Run unit tests with Jest
|
||||
`npm run test:e2e` | Run end-to-end tests with TestCafé
|
||||
`npm run lint` | Run Typescript and SASS linter
|
||||
`npm run lint:ts` | Run Typescript linter
|
||||
`npm run lint:sass` | Run SASS linter
|
||||
`npm run start` | (alias of `npm run start-dev`)
|
||||
`npm run dev` | Build app continously (HMR enabled) and serve @ `http://localhost:3000`
|
||||
`npm run start` | (alias of `npm run dev`)
|
||||
`npm run build` | Build app to `/.next/`
|
||||
`npm run start-prod` | Serve built app (HMR disabled) @ `http://localhost:80`
|
||||
`npm run test` | Run e2e tests verbose with Chrome
|
||||
`npm run test:e2e` | Run end-to-end tests with Headless Chrome
|
||||
`npm run lint` | Run Typescript and CSS linter
|
||||
`npm run lint:es` | Run Typescript linter (ESLint)
|
||||
`npm run lint:css` | Run Stylelint (CSS linter)
|
||||
|
||||
## See also
|
||||
## Learn More
|
||||
|
||||
* [React Webpack Babel Starter](https://github.com/vikpe/react-webpack-babel-starter)
|
||||
* [Isomorphic Webapp Starter](https://github.com/vikpe/isomorphic-webapp-starter)
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
* [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
* [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
||||
|
||||
## Copyright
|
||||
|
||||
Aalto-yliopiston Sähköinsinöörikilta ry
|
||||
Aalto-yliopiston Sähköinsinöörikilta ry
|
||||
|
||||
@@ -21,10 +21,12 @@
|
||||
"homepage": "https://sik.ayy.fi",
|
||||
"scripts": {
|
||||
"build": "next build",
|
||||
"export": "next export",
|
||||
"lint": "npm run lint:es && npm run lint:css",
|
||||
"lint:es": "eslint . --ext .ts,.tsx",
|
||||
"lint:es:fix": "eslint --fix . --ext .ts,.tsx",
|
||||
"lint:css": "stylelint \"./src/**/*.{ts,tsx}\"",
|
||||
"dev": "next dev",
|
||||
"start": "next dev",
|
||||
"start-prod": "next start --port ${SERVER_PORT:=80}",
|
||||
"serve": "next start --port 3000",
|
||||
|
||||
Reference in New Issue
Block a user