Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Merge pull request #6 from WavesHQ/thedoublejay/standard_web
Browse files Browse the repository at this point in the history
feature(standard-web): setup for standard-web
  • Loading branch information
thedoublejay authored Dec 5, 2022
2 parents 70b1884 + f975ae2 commit d64c055
Show file tree
Hide file tree
Showing 5 changed files with 203 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Inspired by [Birthday Research's Sticky](https://github.com/BirthdayResearch/sti
All packages follow the same format `@waveshq/standard-(platform)-*`. All dependencies are published
with the same version tag.

| Package | Type | Description |
| ---------------------------- | ------- | ----------------------------------------------------------------------- |
| @waveshq/standard-web-linter | Linting | Standardized eslint and prettier config for Web based on Next.js rules. |
| Package | Type | Description |
| ---------------------------- | ----------- | ---------------------------------------------------------------------------------- |
| @waveshq/standard-web | Boilerplate | Boilerplate for easier scaffolding of web projects. (Next.js + React + TypeScript) |
| @waveshq/standard-web-linter | Linting | Standardized eslint and prettier config for Web based on Next.js rules. |
18 changes: 18 additions & 0 deletions packages/standard-web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
Web
---

`@waveshq/standard-web`

Standard web tools for scaffolding web applications. Our choice of framework is Next.js as a default for our web projects.

This package also includes a `tsconfig.json` which is customized for web usage.

Packages that are included are based on the requirements of Next.js to avoid version mismatch.

| Package | Description |
| ---------- | ------------------------------------------------ |
| next | Used as the base library. |
| react | Fixes the react version required by Next.js |
| react-dom | Fixes the react version required by Next.js |
| typescript | Fixes the TypeScript version required by Next.js |
19 changes: 19 additions & 0 deletions packages/standard-web/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "@waveshq/standard-web",
"version": "0.0.0",
"files": [
"tsconfig.json"
],
"dependencies": {
"@types/react": "18.0.26",
"@types/react-dom": "18.0.9",
"next": "13.0.6",
"next-sitemap": "^3.1.32",
"nextjs-progressbar": "^0.0.16",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-icons": "^4.7.1",
"react-responsive": "^9.0.2",
"typescript": "4.9.3"
}
}
34 changes: 34 additions & 0 deletions packages/standard-web/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"$schema": "https://json.schemastore.org/tsconfig",
"display": "Default",
"compilerOptions": {
"target": "es5",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": false,
"strictNullChecks": true,
"forceConsistentCasingInFileNames": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve",
"incremental": true,
"baseUrl": "src",
"paths": {
"@content/*": ["../content/*"],
"@api/*": ["api/*"],
"@contexts/*": ["layouts/contexts/*"],
"@components/*": ["components/*"],
"@hooks/*": ["hooks/*"],
"@store/*": ["store/*"],
"@utils/*": ["utils/*"],
"@public/*": ["../public/*"]
}
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
"exclude": ["node_modules", "cypress"]
}
128 changes: 128 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d64c055

Please sign in to comment.