docs: add notes about status of the project (abandoned for the moment)
This commit is contained in:
parent
170bdae725
commit
bb39ae856d
13
README.md
13
README.md
@ -1,12 +1,13 @@
|
|||||||
# Wikipedia Game Solver
|
# Wikipedia Game Solver
|
||||||
|
|
||||||
> \[!IMPORTANT\]
|
> \[!IMPORTANT\]
|
||||||
> The project is a work in progress, at an early stage of development.
|
> The project is abandoned and not maintained anymore.
|
||||||
|
|
||||||
> \[!NOTE\]
|
|
||||||
> The project is also a way to learn and experiment with a clean monorepo architecture, with [Turborepo](https://turbo.build/repo), and [TypeScript](https://www.typescriptlang.org/) as the main language.
|
|
||||||
>
|
>
|
||||||
> The project setup **can be used as a template/boilerplate for new projects**.
|
> It was a proof of concept to deal with large amounts of data in databases, and have some fun dealing with Wikipedia data.
|
||||||
|
>
|
||||||
|
> The project was also a way to learn and experiment with a clean monorepo architecture, with [Turborepo](https://turbo.build/repo), and [TypeScript](https://www.typescriptlang.org/) as the main language.
|
||||||
|
>
|
||||||
|
> The project setup **can be reused as a template/boilerplate for future projects**.
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
@ -21,7 +22,7 @@ Available online: <https://wikipedia-game-solver.theoludwig.fr>
|
|||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org/) >= 22.0.0
|
- [Node.js](https://nodejs.org/) >= 22.0.0
|
||||||
- [pnpm](https://pnpm.io/) >= 9.5.0
|
- [pnpm](https://pnpm.io/) >= 9.9.0
|
||||||
- [Docker](https://www.docker.com/)
|
- [Docker](https://www.docker.com/)
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
2
TODO.md
2
TODO.md
@ -48,7 +48,7 @@
|
|||||||
- [ ] Implement CLI (`cli`)
|
- [ ] Implement CLI (`cli`)
|
||||||
- [ ] Init Clipanion project
|
- [ ] Init Clipanion project
|
||||||
- [ ] Implement `wikipedia-game-solver internal-links --from="Node.js" --to="Linux"` command to get all the possible paths between 2 pages.
|
- [ ] Implement `wikipedia-game-solver internal-links --from="Node.js" --to="Linux"` command to get all the possible paths between 2 pages.
|
||||||
- [ ] Add docs to add locale/edit translations, create component, install a dependency in a package, create a new package, technology used, architecture, links where it's deployed, how to use/install for end users, how to update dependencies with `npx taze -l` etc.
|
- [ ] Add docs to add locale/edit translations, create component, install a dependency in a package, create a new package, technology used, architecture, links where it's deployed, how to use/install for end users, how to update dependencies with `npx taze -l major` etc.
|
||||||
- [ ] GitHub Mirror
|
- [ ] GitHub Mirror
|
||||||
- [ ] Delete `TODO.md` file and instead use issues for the remaining tasks
|
- [ ] Delete `TODO.md` file and instead use issues for the remaining tasks
|
||||||
|
|
||||||
|
@ -6,7 +6,7 @@
|
|||||||
"packageManager": "pnpm@9.9.0+sha512.60c18acd138bff695d339be6ad13f7e936eea6745660d4cc4a776d5247c540d0edee1a563695c183a66eb917ef88f2b4feb1fc25f32a7adcadc7aaf3438e99c1",
|
"packageManager": "pnpm@9.9.0+sha512.60c18acd138bff695d339be6ad13f7e936eea6745660d4cc4a776d5247c540d0edee1a563695c183a66eb917ef88f2b4feb1fc25f32a7adcadc7aaf3438e99c1",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.0.0",
|
"node": ">=22.0.0",
|
||||||
"pnpm": ">=9.5.0"
|
"pnpm": ">=9.9.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "turbo run dev --parallel",
|
"dev": "turbo run dev --parallel",
|
||||||
|
Reference in New Issue
Block a user