Skip to content

readme work on js-base #2

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# js-base-setup
#### What is this repo all about?

- This repo offers a basic setup of a javascript web project which comes with some feature out of the box like page based routing, taiwindcss (optional) etc. So when you are starting a new javascript project why to setup from scratch instead of uing this.
Copy link

Choose a reason for hiding this comment

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

instead of uing this.

spelling typo


#### How to run this project?

- you can run `npm run start` to start the project instantly and in order to build tailwindcss (although it builds runtime) you have to run `npm run build` which actually builds the tailwindcss.
Copy link

Choose a reason for hiding this comment

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

No need to install any dependencies?

Copy link

Choose a reason for hiding this comment

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

Is there an option to run without tailwind as well? How?


#### Want to Contribute or Find a bug?

- We are very happy if you want to make improvement on this repo. Please never hesitate to create an issue & pull request.
Copy link

Choose a reason for hiding this comment

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

But how?