diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..e198ee1 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,31 @@ +# Installation + +Please read through our [Contributing Guidelines](CONTRIBUTING.md). + +## General setup + +Before you start, install dependencies: + +``` +npm install +``` + +Start development server: + +``` +npm run dev +# or +yarn dev +# or +pnpm dev +# or +bun dev +``` + +The website can be accessed at http://localhost:3000. + +In case you need to update dependencies: + +``` +npm update +``` diff --git a/README.md b/README.md index 122e86d..dc727fd 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,13 @@ The repository is a part of the [Montelibero Organization](https://github.com/mo This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - ## Learn More To learn more about Next.js, take a look at the following resources: - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +- [next/font](https://nextjs.org/docs/basic-features/font-optimization) - Automatically optimize and load Inter, a custom Google Font. - [shadcn/ui](https://ui.shadcn.com) - Beautifully designed components that you can copy and paste into your apps. Accessible. Customizable. Open Source. - [Radix Themes](https://www.radix-ui.com) - An open source component library optimized for fast development, easy maintenance, and accessibility. - [Tailwind CSS](https://tailwindcss.com) - A utility-first CSS framework packed with classes like flex, pt-4, text-center and rotate-90 that can be composed to build any design, directly in your markup.