Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enter README file first iteration #6

Merged
merged 6 commits into from
Feb 1, 2024
Merged

Enter README file first iteration #6

merged 6 commits into from
Feb 1, 2024

Conversation

adriamarcet
Copy link
Member

Add README (file) description on how to install and use this project and basic information about Runroom.

Closes #3

@adriamarcet adriamarcet self-assigned this Jan 29, 2024
@adriamarcet
Copy link
Member Author

Adding screencap:

image

@SpykeRel04D
Copy link
Member

Hello :)

I think it would be interesting to mention:

1 - npm run dev:test: So use a MSW server.
2 - make: Docker integration and how to use it (and why)

izm20
izm20 reviewed Jan 30, 2024
View reviewed changes
README.md Outdated
@@ -1,36 +1,67 @@
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://github-production-user-asset-6210df.s3.amazonaws.com/13334047/300512392-9604f571-d3d5-4751-9033-8ded16012537.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240129%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240129T152550Z&X-Amz-Expires=300&X-Amz-Signature=d4b63a2ed6f298048702cd9d199ed46cb4df9f463489a5e0046f58a52b78eb58&X-Amz-SignedHeaders=host&actor_id=1675045&key_id=0&repo_id=745470551)](https://runroom.com)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried it locally and I think the image is not loading properly 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right! Changing the URL

@adriamarcet
Copy link
Member Author

Hello :)

I think it would be interesting to mention:

1 - npm run dev:test: So use a MSW server. 2 - make: Docker integration and how to use it (and why)

Just commited some basic information for Docker setup inside the Readme file. Also added a new issue about Docker image name.

@adriamarcet
Copy link
Member Author

Adding another screencap preview here so you can easily see the latest changes:

imagen

@jordisala1991
Copy link
Member

I think we should also add the badge for the CI Status.

jordisala1991
jordisala1991 reviewed Jan 31, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
jordisala1991
jordisala1991 reviewed Jan 31, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@adriamarcet
Copy link
Member Author

I think we should also add the badge for the CI Status.

Added the badge

@adriamarcet adriamarcet merged commit 9edd07b into main Feb 1, 2024
3 checks passed
@adriamarcet adriamarcet deleted the feature/add-proper-readme branch February 1, 2024 09:47
@jordisala1991 jordisala1991 mentioned this pull request Feb 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jordisala1991 jordisala1991 jordisala1991 approved these changes

@izm20 izm20 izm20 approved these changes

@aerrasti aerrasti Awaiting requested review from aerrasti

@SpykeRel04D SpykeRel04D Awaiting requested review from SpykeRel04D

@irenearan irenearan Awaiting requested review from irenearan

@eddsaura eddsaura Awaiting requested review from eddsaura

@joshuaRunroom joshuaRunroom Awaiting requested review from joshuaRunroom

Assignees

@adriamarcet adriamarcet

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add proper Readme file content
5 participants
@adriamarcet @SpykeRel04D @jordisala1991 @eddsaura @izm20