Merge pull request #6 from Runroom/feature/add-proper-readme

Enter README file first iteration

README.md

@@ -1,36 +1,76 @@
-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).
+# NextJS Starter by Runroom
+[![Runroom. We think. We do. We connect.](https://private-user-images.githubusercontent.com/1675045/301127464-5f88a3a9-c7e2-45b4-b5db-355a9ca93537.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MDY2OTczMDIsIm5iZiI6MTcwNjY5NzAwMiwicGF0aCI6Ii8xNjc1MDQ1LzMwMTEyNzQ2NC01Zjg4YTNhOS1jN2UyLTQ1YjQtYjVkYi0zNTVhOWNhOTM1MzcucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDEzMSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDAxMzFUMTAzMDAyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZjlmYzI2ZGViOTNiMzI5MzdmOWI1YThiZDMwYzM3YmVhNzU0ZjIwYTQyOTMwMmJkN2IyZDlmOTQxZTExOTJjZiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.DmIAXn-LCcYgZRxfBO15L35KepuhZcrEV1pJrOC9ZGo)](https://runroom.com)
 
-## Getting Started
+[![CI](https://github.com/Runroom/starter-next-js/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/Runroom/starter-next-js/actions/workflows/ci.yaml)
 
-First, run the development server:
+## Setting up your local repo
+This starter uses **NPM** to manage dependencies and **Node version >= 20** to be executed. In order to clone and start it you can use this following commnads in your local machine:
 
 ```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+git clone git@github.com:Runroom/starter-next-js.git
+cd starter-next-js
+npm install
+```
+
+This will leave everything ready to checkout your localhost starter site. To run your localhost environment you can use the following commands:
+
+```bash
+npm run build
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+After this command execution **you can access** `http://localhost:3000` with your browser and see the initial page.
+
+
+## Local Development
+When developing with this starter you can the following command to **enable a development environment** and **live reload** to see your code changes instantly affecting the frontend:
+
+```bash
+# Run a NextJS server and checkout http://localhost:3000/
+npm run dev
+# Run a test server with Mock Service Workers
+npm run dev:test
+```
 
 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.
+## Local Development with Docker
+We have created a basic Docker config to enable local development environment as well. You can see all options listed in `.docker/makefile` and run the following command to use it:
+
+```bash
+# Run a Docker server and checkout http://localhost:3000/
+make
+```
+
+## Running tests
+We have added this short commands to run unit and end to end testing than you can use:
+
+```bash
+# Run all Unit testing with Vitest
+npm run test
+# Run all End to End testing with Cypress
+npm run e2e:dev:test
+```
+
+## Contribution
+We are **happy to receive contributions** to this starter. If you want to contribute you can follow the next steps:
+
+- Fork this repository
+- Create your feature branch (`git checkout -b my-new-feature`)
+- Commit your changes (`git commit -am 'Add some feature'`)
+- Push to the branch (`git push origin my-new-feature`)
+- Create a new Pull Request
 
-## Learn More
+Also [we are keeping track of issues for this project here](https://github.com/Runroom/starter-next-js/issues), feel free to check them or **contribute and help us** with any of them.
 
-To learn more about Next.js, take a look at the following resources:
+## License
 
-- [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.
+This starter is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
 
-## Deploy on Vercel
+---
+## Runroom ♥
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+[Runroom is a software development company](https://runroom.com) based in Barcelona. We are a team of passionate developers and designers that create memorable experiences for your customers.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+### More open Source Projects made at Ruroom:
+* [Stooa](https://github.com/Stooa): The free & open source fishbowl solution, where online unconference events happen.