🛠️ Utilisation
Voyez comment utiliser Singulary de la meilleure des manières.
Singulary est un service simple mais la mise en place de bonnes pratiques, réduiront drastiquement votre consommation de token, les temps d'attentes et vous obtiendrez des réponses plus pertinantes.
Singulary Chat
đź§ Echanger avec Singulary
Quand vous discutez avec Singulary, vous devez garder en tête que vous discutez avec un collaborateurs. L'IA doit être perçu comme un compagnon de travail que d'un simple outil.
Singulary est donc pour vos projet:
- Un senior développeur: Singulary dispose de grandes connaissances dans le développement, parlez lui comme çi c'était un développeur qui a toujours réponse à tout.
- Un expert dans la tech: Vous pouvez lui poser des questions plus vagues, comme par example: "Comment améliorer la sécurité dans mon projet", Singulary peut aller au delà de ce que vous lui donné comme information.
- Un développeur backend et frontend: Singulary peut à la fois répondre à vos besoin coté UI/UX mais aussi coté server.
- Un soutien Singulary peut vous faire gagner beaucoup de temps et vous alléger des tâches redondantes ou chronophages.
Par example vous pourriez lui poser:
Comment améliorer la sécurité dans mon projet ?
Quel est le fichier qui me permet de modifier la home page ?
Que verais-tu comme amélioration dans mon projet ?
📖 Générer votre documentation
Un des gros points fort de Singulary est que vous pouvez générer automatiquement des documentations pour vos projets. Imaginons que vous souhaitez partager a vos collaborateurs votre vision, vous pouvez.
Pour ce faire vous n'avez qu'a créer un projet Singulary, vous rendre ensuite dans l'outil Documentation et cliquer sur générer.
Attention vous ne pouvez générer qu'une seule documentation à la fois, la précedente sera écrasée par la nouvelle
Code Editor
You’ll need a code editor to work on the project. Common options include:
- Visual Studio Code
- WebStorm
- Any other text editor you prefer.
Required Knowledge
- Next.js: Since this is a Next.js project, you should be familiar with Next.js basics.
- React: The project uses React, so understanding React's component structure and hooks will help.
- TypeScript: The project is written in TypeScript, so you should have a basic understanding of it.
- Tailwind: The project uses Tailwind CSS for styling.
- MDX: Markdown + JSX (MDX) is used for writing documentation.
Installation
Clone the Repository
First, clone the repository to your local machine using Git:
git clone https://github.com/rubixvi/rubix-documents.git
Change the directory to the project folder:
cd rubix-documents
Install Dependencies
Use npm to install all the required dependencies:
npm install
This will install all the dependencies listed in the package.json file, including:
- Next.js
- React
- TypeScript
- Tailwind CSS
- MDX components
- Other dependencies like ESLint, PostCSS, Husky, etc.
Running the Development Server
Start the development server by running:
npm run dev
This will start the local server, and you can open your browser at:
http://localhost:3000
Editing the Project
- MDX Files: Documentation content is stored in
contents/docs. - Components: You can edit React components in the
components/directory. - Tailwind: Tailwind styling are managed in
tailwind.config.tsandapp/globals.css.
To make any changes to the project, open the files in your editor and modify them as needed.
Required:
The project's search functionality relies on the Husky's automation to build
search-data/documents.json ensure git commit is performed to generate this
file.
Building for Production
Once you’ve made your changes and want to build the project for production:
npm run build
This will generate a production-ready build of the app.
Running Production Server
To run the production server:
npm run start
The production app will be available at:
http://localhost:3000
Optional
Deploying to Vercel
This project is optimized for Vercel deployment. To deploy to Vercel:
- Go to vercel.com and sign up.
- Link your GitHub repository and deploy the project.
- Vercel will handle the build process for you automatically.
Linting and Pre-commit Hooks
The project uses ESLint for linting and Husky for Git hooks. These tools are configured automatically, but you can customize them in .eslintrc.json and .husky directories.
Important Information
The project's search functionality relies on the Husky's automation to build search-data/documents.json ensure git commit is performed to generate this file.