https://github.com/william-fernandes252/advisor.ai-web
Web front-end of the advisor.ai project, an article search and recommendation platform focused on promoting collaboration between researchers using AI.
https://github.com/william-fernandes252/advisor.ai-web
biome machine-learning material-ui next-auth nextjs react recommender-system typescript
Last synced: 8 months ago
JSON representation
Web front-end of the advisor.ai project, an article search and recommendation platform focused on promoting collaboration between researchers using AI.
- Host: GitHub
- URL: https://github.com/william-fernandes252/advisor.ai-web
- Owner: William-Fernandes252
- License: mit
- Created: 2024-04-13T13:53:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-30T21:38:45.000Z (over 1 year ago)
- Last Synced: 2025-01-04T09:03:08.655Z (9 months ago)
- Topics: biome, machine-learning, material-ui, next-auth, nextjs, react, recommender-system, typescript
- Language: TypeScript
- Homepage:
- Size: 228 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# advisor.ai Web
Web front-end of the advisor.ai project, an article search and recommendation platform focused on promoting collaboration between researchers using AI.
[](./LICENSE)
## Development
### Requirements
The web version of the advisor.ai platform is built with [Next.js](https://nextjs.org/docs). Also, it uses [pNpm](https://pnpm.io/) as dependency manager.
In order to run it locally, make shure you have installed
- Node.js `21.7.3`
- pNpm `2.12.3`
### Installation
To install the web dependencies, run
```bash
pnpm install
```
### Run locally
To run the development server, execute
```bash npm run dev
pnpm dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Tests and coverage
This project is being tested with [Vitest](https://vitest.dev/).
To run the unit and integration tests, execute
```bash
pnpm run test:unit
```
To see the current test coverage, run
```bash
pnpm run coverage
```
### Code quality
This project uses [Biome](https://biomejs.dev/) as code formatter and linter.
In order to validate the code and correct the auto fixable issues, run
```bash
pnpm run check
```