Skip to content

Commit b4cef19

Browse files
committed
docs: add readme (#6)
1 parent 494eb4a commit b4cef19

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<!-- [![Contributors][contributors-shield]][contributors-url] -->
2+
3+
[![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url]
4+
[![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]
5+
[![LinkedIn][linkedin-shield]][linkedin-url]
6+
7+
<!-- PROJECT LOGO -->
8+
<br />
9+
<p align="center">
10+
<h1 align="center">Rick and Morty web for Gentleman Programming Hackathon</h1>
11+
12+
<p align="center">
13+
Bussiness idea: build a website for the fandom of Rick and Morty series where the users can find all characters, episodes and locations. Profit is gained throught satisfying the fandom and engaging more users. Next level might be adding an ecommerce where users can buy Rick and Morty stuff.
14+
<br />
15+
<!-- <a href="https://github.com/aireck2/rm-vite-ts"><strong>Explore the docs »</strong></a>
16+
<br /> -->
17+
<!-- <br /> -->
18+
<a href="https://rick-y-morty-aireck.vercel.app/">View Demo</a>
19+
·
20+
<a href="https://github.com/aireck2/rm-vite-ts/issues">Report Bug</a>
21+
·
22+
<a href="https://github.com/aireck2/rm-vite-ts/issues">Request Feature</a>
23+
</p>
24+
</p>
25+
26+
<a href="https://rick-y-morty-aireck.vercel.app/">
27+
<img src="./public/images/demo.png" alt="Logo" width="100%" height="100%">
28+
</a>
29+
30+
## 🚀 Instructions / How to start the project
31+
32+
1. Downloard/clone the git repository
33+
2. Open terminal/command prompt
34+
3. cd (change directory) into the project folder
35+
4. Run `npm install` in your terminal
36+
5. Run `npm run dev` to run the frontend
37+
6. Open your browser and navigate to `http://localhost:5173/`
38+
39+
**Make sure to add yours env vars in .env file as is shown in .env.test file**
40+
41+
## Contributing
42+
43+
Contributions are what make the open source community such an amazing place to be learn, inspire,
44+
and create. Any contributions you make are **greatly appreciated**.
45+
46+
Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a
47+
branch, add commits, and [open a pull request](https://github.com/aireck2/portfolio-ts/compare/).
48+
49+
<!-- 1. Fork the Project
50+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
51+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
52+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
53+
5. Open a Pull Request -->
54+
55+
<!-- LICENSE -->
56+
57+
## License
58+
59+
Distributed under the MIT License. See `LICENSE` for more information.
60+
61+
<!-- CONTACT -->
62+
63+
## Contact
64+
65+
Erick Escriba - [@erickescribaa](https://twitter.com/erickescribaa) - [email protected]
66+
67+
Project Link: [https://github.com/aireck2/rm-vite-ts](https://github.com/aireck2/rm-vite-ts)
68+
69+
[contributors-shield]: https://img.shields.io/github/contributors/aireck2/rm-vite-ts.svg?style=for-the-badge
70+
[contributors-url]: https://github.com/aireck2/rm-vite-ts/graphs/contributors
71+
[forks-shield]: https://img.shields.io/github/forks/aireck2/rm-vite-ts.svg?style=for-the-badge
72+
[forks-url]: https://github.com/aireck2/rm-vite-ts/network/members
73+
[stars-shield]: https://img.shields.io/github/stars/aireck2/rm-vite-ts.svg?style=for-the-badge
74+
[stars-url]: https://github.com/aireck2/rm-vite-ts/stargazers
75+
[issues-shield]: https://img.shields.io/github/issues/aireck2/rm-vite-ts.svg?style=for-the-badge
76+
[issues-url]: https://github.com/Aireck2/rm-vite-ts/issues
77+
[license-shield]: https://img.shields.io/github/license/aireck2/rm-vite-ts.svg?style=for-the-badge
78+
[license-url]: https://github.com/aireck2/portfolio-next/blob/develop/LICENSE
79+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
80+
[linkedin-url]: https://linkedin.com/in/erickescriba
81+
[product-screenshot]: images/screenshot.png

0 commit comments

Comments
 (0)