Skip to content

Commit

Permalink
Doc: Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelMariscal committed Aug 28, 2023
1 parent ee461ed commit 3eacec1
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
## Loading...
<h2>Inbox Refeições Website</h2>

<p>If interested, here somo quick links to <a href="https://www.figma.com/file/ZWq615NzFueILcVvZKfXoJ/InboxRef-Web?type=design&node-id=0%3A1&mode=design&t=Nq5xNdtCZegzDBfO-1">Access the Figma Project</a> and to <a href="https://inboxrefeicoes.vercel.app/">Access the Website</a>.</p>

<h2 id="GettingStarted">Getting Started</h2>

<h3>Installing</h3>

**Cloning the Repository**

```
$ git clone https://github.com/RafaelMariscal/inbox-website
```

**Installing dependencies**

```
$ cd inbox-website
$ npm install
```

**Project start**

```
$ npm run build
$ npm start
```

**Development version**

```
$ npm run dev
```

<h2 id="Contributing">Contributing</h2>

You can send how many PR's do you want, I'll be glad to analyse and accept them! And if you have any question about the project...

Email-me: <a href="mailto: rafael_mariscal_@outlook.com">rafael*mariscal*@outlook.com</a>

Connect with me at [LinkedIn](https://www.linkedin.com/in/rafael-mariscal/).

0 comments on commit 3eacec1

Please sign in to comment.