Mathis b62e51af70 feat: Update README file extensively

The README file has been greatly expanded, providing a comprehensive documentation for the project. Details include a brief description, appendix note, API references, color references, installation guidelines, deployment instructions and listing of tech stack being used.

2024-06-06 14:26:10 +02:00

660 B

Raw Blame History

YeloBit (brief-07)

A brief description of what this project does and who it's for

Appendix

This a scholarship project !

API Reference

Available at XXXX

Color Reference

https://ui.jln.dev/theme/7P8zdFFGSfMPUKfp

Installation

Install my-project with npm

  git clone ssh://git@git.yidhra.fr:3022/WorkSimplon/brief-07-front.git
  cd brief-07-front
  pnpm i

Deployment

To deploy this project run

  npm run deploy

Tech Stack

Client: NextJS, TailwindCSS, RadixUi, Shadcn/ui, Axios

660 B Raw Blame History