Skip to content

Commit

Permalink
docs: 📝 refresh readme design
Browse files Browse the repository at this point in the history
add logo and make beautiful header
  • Loading branch information
dvirberlo committed Aug 5, 2022
1 parent b158063 commit 262c2be
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# Opinion Me

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.0.0.
<!-- design inspired by https://github.com/kamranahmedse/developer-roadmap -->
<div align="center">
<a href="https://opinion-me-testing.web.app"><img src="./src/assets/svg_icons/app-icon.svg/" height="128"></a>
<h2 align="center">Opinion Me</h2>
<p align="center">Web App for getting feedback and giving feedback on ideas.<p>
<div align="center">
&nbsp;&nbsp;<a href="./docs/roadmap.md">Roadmap</a>&nbsp;&nbsp;
&nbsp;&nbsp;<a href="https://github.com/angular/angular-cli">Angular v14</a>&nbsp;&nbsp;
&nbsp;&nbsp;<a href="https://opinion-me-testing.web.app">WebApp</a>&nbsp;&nbsp;
&nbsp;&nbsp;<a href="./README.md#Contribute">Contribute</a>&nbsp;&nbsp;
</div>
</div>

The main purpose of this project was to learn Angular and Firebase, by creating a web app for getting feedback and giving feedback on ideas.

The project is hosted at [opinion-me-testing.web.app](https://opinion-me-testing.web.app).

## Contribute

Feel free to issue bug reports and feature requests.

Please first check the [roadmap.md](./docs/roadmap.md) and existing [issues](../../issues).
Please first check the [roadmap](./docs/roadmap.md) and existing [issues](../../issues).

If you want to write it yourself- open an issue and declare your intension. [PRs](../../pulls) will be wellcomed.

Expand All @@ -26,4 +33,4 @@ Navigate to [`http://localhost:4200/`](http://localhost:4200/).

Run `yarn test` to execute the unit tests via [Karma](https://karma-runner.github.io).

(Run `yarn run fire-emu` and then `yarn run fire-test` to test firestore rules.)
(Run `yarn run fire-emu` and then `yarn run fire-test` to unit test firestore rules)

0 comments on commit 262c2be

Please sign in to comment.