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.

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

Updated README.md #38

Merged
merged 9 commits into from Apr 9, 2022
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion .env.sample
@@ -1 +1,2 @@
REACT_APP_API_BASE_URL=XXXXX
REACT_APP_API_BASE_URL=XXXXX
REACT_APP_API_BASE_URL_LOCAL=http://localhost:4000
Adi-11 marked this conversation as resolved.
Show resolved Hide resolved
67 changes: 54 additions & 13 deletions README.md
@@ -1,12 +1,20 @@
# OC-Frontend
# OC-Frontend

<img alt="open certs" align="right" width="200" src="https://user-images.githubusercontent.com/41825906/153617213-e956c616-4f4a-4d62-95af-2d4ac4d57942.png">

> This includes the frontend for Open-Certs.
> This includes the frontend for Open-Certs. 📜

After seeing so many open-source projects being monetized :dollar: without giving any recognition to contributors, Open-Certs comes with the vision to certify every open-source contribution :tickets:.

It really is that easy! 💚

And the best part of it? **Open-Certs is open source!** 🤩

You can also contribute to it 🏆.

**The website is live and can be visited on https://open-certs.dev/** 😃

After seeing so many open-source projects being monetized without giving any recognition to contributors, Open-Certs comes with the vision to certify every open-source contribution.

Open-Certs frontend is based on component-based architecture. It takes advantage of `Reactjs` as UI library, `Typescript` as programming language, `TailwindCSS`, `Material-UI`, etc and consumes [Open-Certs-Backend](https://github.com/open-certs/oc-backend) to delivery required services to the users.

<p align="center">
<br/>
Expand All @@ -16,7 +24,27 @@ Open-Certs frontend is based on component-based architecture. It takes advantage
<a href="https://open-certs.dev/" target="_blank">Live-Demo</a>
</p>

## Setup
## Table of Contents 🔖

- [Major Objective](#major-objective-pushpin)
- [Tech Stack](#tech-stack-)
- [Set Up](#set-up-)
- [Running the application locally](#running-the-application-locally-%EF%B8%8F)
- [Contributing](#contributing-)
- [Contribution Guidelines](#contribution-guidelines-)
- [Contributors](#contributors)
- [Visitor's Count](#visitors-count-)
<br><br>
## Major Objective :pushpin:

- To let beginners venture into the world of Open Source.
- To provide validation to every open-source contribution.
<br><br>
## Tech Stack 💻

Open-Certs frontend is based on component-based architecture. It takes advantage of `Reactjs` as UI library, `Typescript` as programming language, `TailwindCSS`, `Material-UI`, etc and consumes [Open-Certs-Backend](https://github.com/open-certs/oc-backend) to delivery required services to the users.
<br><br>
## Set Up 🔨

- To get started, install the required node modules:

Expand All @@ -25,16 +53,16 @@ yarn install
```

- Then copy the `.env.sample` to `.env` and configure it.

## Run
<br><br>
## Running the application locally ⚙️

Then issue the following command to run the server:

```
yarn start
```

## Contributing
<br><br>
## Contributing 🏗

Any contributions you make are **greatly appreciated**.

Expand All @@ -46,7 +74,20 @@ Any contributions you make are **greatly appreciated**.
6. Push to the Branch (`git push origin feature/AmazingFeature`)
7. Open a Pull Request on `dev` branch

## Contributors:
**Voila :exclamation: You have made a PR to the Open-Certs :boom: . Wait for your submission to be accepted ✔️ and your PR to be merged.**

**Congratulations! 🎉 You've made your first contribution! 🙌🏼**
<br><br>
## Contribution Guidelines 📋

- Please read our [Code of Conduct](https://github.com/open-certs/oc-frontend/blob/main/CODE_OF_CONDUCT.md) file for contributing towards the project.
- If you are creating an issue, please make sure that it is a valid and significant issue that will actually contribute towards the project.
- Write clear meaningful git commit messages 📧.
- Make sure your PR's description is clear and it mentions the issue number that your PR fixes.
- When you're submitting a PR, it would be really awesome if you add a screenshot 📸 or video 📽️ of your change or a link 🔗 to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
- When you make very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git))
<br><br>
## Contributors

### Credits goes to these people: ✨

Expand All @@ -59,6 +100,6 @@ Any contributions you make are **greatly appreciated**.
</td>
</tr>
</table>
<p align="center">
<h2 align="center">Visitor's Count <img align="center" src="https://profile-counter.glitch.me/open-certs/count.svg" alt="Visitor Count" /></h2>
</p>

## Visitor's Count 📍
<img align="center" src="https://profile-counter.glitch.me/open-certs/count.svg" alt="Visitor Count" />
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -21,7 +21,7 @@
"react-icons": "^4.3.1",
"react-lottie": "^1.2.3",
"react-router-dom": "^6.2.1",
"react-scripts": "5.0.0",
"react-scripts": "^5.0.0",
"react-toastify": "^8.2.0",
"sitemap": "^7.1.1",
"sweetalert2": "^11.4.0",
Expand Down
16 changes: 8 additions & 8 deletions yarn.lock
Expand Up @@ -6336,9 +6336,9 @@ minimatch@^3.0.4:
brace-expansion "^1.1.7"

minimist@^1.1.1, minimist@^1.2.0, minimist@^1.2.5:
version "1.2.5"
resolved "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz"
integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
version "1.2.6"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==

mkdirp@^0.5.5, mkdirp@~0.5.1:
version "0.5.5"
Expand Down Expand Up @@ -6412,9 +6412,9 @@ node-environment-flags@^1.0.5:
semver "^5.7.0"

node-forge@^1.2.0:
version "1.2.1"
resolved "https://registry.npmjs.org/node-forge/-/node-forge-1.2.1.tgz"
integrity sha512-Fcvtbb+zBcZXbTTVwqGA5W+MKBj56UjVRevvchv5XrcyXbmNdesfZL37nlcWOfpgHhgmxApw3tQbTr4CqNmX4w==
version "1.3.0"
resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.0.tgz#37a874ea723855f37db091e6c186e5b67a01d4b2"
integrity sha512-08ARB91bUi6zNKzVmaj3QO7cr397uiDT2nJ63cHjyNtCTWIgvS47j3eT0WfzUwS9+6Z5YshRaoasFkXCKrIYbA==

node-int64@^0.4.0:
version "0.4.0"
Expand Down Expand Up @@ -7600,9 +7600,9 @@ react-router@6.2.1:
dependencies:
history "^5.2.0"

react-scripts@5.0.0:
react-scripts@^5.0.0:
version "5.0.0"
resolved "https://registry.npmjs.org/react-scripts/-/react-scripts-5.0.0.tgz"
resolved "https://registry.yarnpkg.com/react-scripts/-/react-scripts-5.0.0.tgz#6547a6d7f8b64364ef95273767466cc577cb4b60"
integrity sha512-3i0L2CyIlROz7mxETEdfif6Sfhh9Lfpzi10CtcGs1emDQStmZfWjJbAIMtRD0opVUjQuFWqHZyRZ9PPzKCFxWg==
dependencies:
"@babel/core" "^7.16.0"
Expand Down