1.0.0-explorer • Published 17 hours ago

ode-explorer v1.0.0-explorer

Weekly downloads
-
License
GPL-3.0
Repository
github
Last release
17 hours ago

Open Digital Education Explorer

This is a ReactJS + Vite app.

What is inside?

Many tools are already configured like:

See all tools

Getting Started

Install

Install all dependencies.

yarn

Dev

Start project

Open your project with Vite Server + HMR at http://localhost:3000.

yarn dev

Server Options

You can change Vite Server by editing vite.config.ts

server: {
  host: "0.0.0.0",
  port: 3000,
  open: true // open the page on <http://localhost:3000> when dev server starts.
}

Absolute Imports

You should use absolute imports in your app

Replace ../components/* by components/*

Edit vite.config.ts and add an alias

Telling Vite how to build import path:

alias: [
  { find: "~", replacement: path.resolve(__dirname, "src") },
  {
    find: "components",
    replacement: path.resolve(__dirname, "./src/components"),
  },
]

Add your new path to tsconfig.json:

Telling TypeScript how to resolve import path:

"baseUrl": "./src",
"paths": {
  "components/*": ["./components/*"],
}

Lint

yarn lint

Prettier

Prettier write and check separately

yarn format:write
yarn format:check

Prettier everything once

yarn format

Lighthouse

LHCI will check if your app respect at least 90% of these categories: performance, a11y, Best practices and seo

yarn lighthouse

Pre-commit

When committing your work, pre-commit will start yarn lint-staged:

lint-staged starts lint + prettier

yarn pre-commit

Build

TypeScript check + Vite Build

yarn build

Preview

yarn preview

License

This project is licensed under the AGPL-3.0 license.

1.4.3

2 days ago

1.4.2

1 month ago

1.4.1

2 months ago

1.4.0

2 months ago

1.3.3

3 months ago

1.3.2

3 months ago

1.3.1

5 months ago

1.3.0

5 months ago

1.1.1

6 months ago

1.1.0

6 months ago

1.1.2

6 months ago

1.0.5

7 months ago

1.0.4

7 months ago

1.0.3

7 months ago

1.2.2

8 months ago

1.0.2

8 months ago

1.0.1

8 months ago

1.0.0

10 months ago

1.0.0-next.1

1 year ago

1.0.0-explorer

1 year ago