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

Add setup instruction #28

Closed
wants to merge 2 commits into from
Closed

Add setup instruction #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc2043a
Add setup instruction
sarthaksarthak9 Sep 27, 2023
233428a
Add setup instruction
sarthaksarthak9 Sep 27, 2023
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
37 changes: 37 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
# Mercurius
Community Newsletter Initiative

## Follow the steps to setup the project locally

## pre-requisite:
<br>
you should have npm and hugo installed in your system
<br>

### Install tailwind CSS
```
npm install tailwindcss
```

### Build the Website:

<p> After you've installed Tailwind CSS and ensured that your SCSS file is correctly importing it, try building your website again with Hugo:</p>

<br>

```
hugo
```

<p> If the build succeeds without errors, you can then start the development server:</p>

```
hugo server -D

```

### Acess the UI

<p> copy paste the below URL at your browser </p>

```
localhost:1313
```