Nectar-Topics / README.md
CEBangu's picture
First map commit
ab5b575
---
title: Nectar Topics
emoji: 🤖
colorFrom: gray
colorTo: red
sdk: docker
pinned: false
app_port: 3000
---
# BunkaTopics web app
This project was made to show the results of [BunkaTopics](https://github.com/charlesdedampierre/BunkaTopics).
Bunkatopics is a Topic Modeling Visualisation, Frame Analysis & Retrieval Augmented Generation (RAG) package that leverages LLMs
It is built around React and D3.js and made to work with the `api` in the same repository
## Usage
- Please copy `env.model` to `.env` before starting the server
- `make docker_build`
- `make docker_run`
## Developping
In the project directory, you can run a development server:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Remove react-scripts helper : `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).