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.

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

chore: init repository tooling #1

Merged
merged 12 commits into from
Oct 18, 2023
Merged

chore: init repository tooling #1

merged 12 commits into from
Oct 18, 2023

Conversation

remidej
Copy link
Contributor

@remidej remidej commented Oct 16, 2023

Sets up a TS React component library with Vite. Also sets up eslint, prettier, jest and husky.

The tools and configs were inspired by both the design system and the monorepo.

@remidej remidej self-assigned this Oct 17, 2023
@remidej remidej added the pr: chore Cleanups / dependencies / tooling / styling label Oct 17, 2023
Copy link
Contributor

@joshuaellis joshuaellis left a comment

Choose a reason for hiding this comment

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

Great start @remidej,

lol too eager

Copy link
Contributor

@joshuaellis joshuaellis left a comment

Choose a reason for hiding this comment

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

Great start @remidej, left some inline thoughts for discussion 👍🏼

.eslintrc Outdated Show resolved Hide resolved
vite.config.ts Outdated Show resolved Hide resolved
tsconfig.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@remidej remidej requested a review from joshuaellis October 17, 2023 10:01
.eslintrc Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@joshuaellis joshuaellis left a comment

Choose a reason for hiding this comment

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

I would add some github stuff – PR template, ISSUE templates, & workflows – the design-system could be a good source of inspo for these things as it's a lot lighter than the CMS repo. I would also add a CONTRIBUTING guide too, this could be adapted from the CMS one too...

A basic README.md that you add too overtime is probably very good practice as it's the source of documentation for the project :)

.husky/pre-commit Outdated Show resolved Hide resolved
@remidej
Copy link
Contributor Author

remidej commented Oct 17, 2023

@joshuaellis I added some github templates, a super basic readme and a code of conduct.

I think I prefer to wait a bit before writing the contributing guide and a more detailed readme, as it will be clearer what we need to put there once we have locked down the API and started the implementation.

@remidej remidej requested a review from joshuaellis October 17, 2023 15:43
@joshuaellis
Copy link
Contributor

a more detailed readme

Definitely, I didn't expect you to have it written to a tee, instead I'd probably expect you to update it as you build the API so it's constantly up to date, good habit to get into 🤓

Copy link
Contributor

@joshuaellis joshuaellis left a comment

Choose a reason for hiding this comment

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

There's probably something forgotten, but you can always add it later – great work @remidej, setting up a brand new project has a lot of things to consider 🤪

@remidej remidej merged commit ab4280f into main Oct 18, 2023
@remidej remidej deleted the init-repo branch October 18, 2023 07:55
Copy link

@madhurisandbhor madhurisandbhor left a comment

Choose a reason for hiding this comment

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

I was interested to check how you created renderer, have few questions if you can answer, thanks!

Comment on lines +56 to +57
"@testing-library/react": "^14.0.0",
"lint-staged": "^15.0.1"

Choose a reason for hiding this comment

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

these dependencies should be dev right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

definitely 🙃

Comment on lines +83 to +84
"react": "^18.0.0",
"react-dom": "^18.0.0",

Choose a reason for hiding this comment

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

why do we need these in devdeps as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

otherwise we get eslint warnings about them not being installed

Comment on lines +23 to +28
# local env files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

Choose a reason for hiding this comment

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

we can clean this file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They're valid environment files picked up by vite, so people could be using them: https://vitejs.dev/guide/env-and-mode.html#env-files

Choose a reason for hiding this comment

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

right, but we do not have anything defined at the moment to gitignore. No worries as it's not doing any harm, let it be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: chore Cleanups / dependencies / tooling / styling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants