project-guava-web

KO | EN

gitlite — search

#hacktoberfest #llm #go #golang #machine-learning #deep-learning #java #windows #awesome #cli #awesome-list #vue #security #openai

project-guava-web

(★ 15)

User Interface for the Digital Certificate Generation project. Developed using React and deployed to Cloudflare Pages.

project-guava-web Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](https://raw.githubusercontent.com/dscnitrourkela/project-guava-web/main/)

[![Starware](https://img.shields.io/badge/Starware-⭐-black?labelColor=f9b00d)](https://github.com/zepfietje/starware)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<h3 align="center">Signit</h3>

Digital Certificate Generation and Distribution
 
 
 <a href="https://signit.dscnitrourkela.org">View Demo</a>
 ·
 <a href="https://github.com/dscnitrourkela/project-guava-web/issues">Report Webapp Bugs</a>
 .
 <a href="https://github.com/dscnitrourkela/project-guava/issues">Report Server Bugs</a>

<details open="open">
 <summary>Table of Contents</summary>
 <ol>
 <li>
 <a href="#about-the-project">About The Project</a>
 <ul>
 </ul>
 <li><a href="#built-with">Built With</a></li>
 
 </li>
 <li>
 <a href="#getting-started">Getting Started</a>
 <ul>
 <li><a href="#prerequisites">Prerequisites</a></li>
 <li><a href="#contribution-guidlines">Contribution guidlines</a></li>
 <li><a href="#local-repository-setup">Local Repository Setup</a></li>
 <li><a href="#running-the-project">Running the project</a></li>
 </ul>
 </li>
 <li><a href="#roadmap">Roadmap</a></li>
 <li><a href="#license">License</a></li>
 <li><a href="#dsc-nit-rourkela">DSC NIT Rourkela</a></li>
 <li><a href="#starware">Starware</a></li>
 <li><a href="#contributors">Contributors</a></li>
 </ol>
</details>

## About The Project

[![Signit Certificate Compose][product-screenshot]](https://signit.dscnitrourkela.org)

A completely digital and customizable solution for managing all your certificates.

- The project repository for the web application of an open system to generate and manage certificates.
- Login to initiate a request to authorize a certificate.
- After successful authorization, digitally sign the certificate.
- Once done, distribute to the participants through our portal.

Features:

- No restrictions on certificate design. Upload your own designs.
- Easily drag and drop the location of sign on the certificate.
- Add a maximum of 3 signees per certificate.
- Manage easily all your approved and pending certificates via our dashboard.

A list of commonly used resources that I find helpful are listed in the
acknowledgements.

### Built With

Following technologies and libraries are used for the development of this
project.

- [Create React App](https://create-react-app.dev/)
- [Typescript](https://www.typescriptlang.org/)
- [Material UI](https://www.typescriptlang.org/)
- [React Konva](https://konvajs.org/docs/react/index.html)
- [React Testing Library](https://testing-library.com/)

## Getting Started

To setup the project locally follow the steps below

### Prerequisites

- [Node.js](https://nodejs.org/en/download/)

```sh
  # Homebrew
  brew install nodejs

# Sudo apt
  sudo apt install nodejs

# Packman
  pacman -S nodejs

# Module Install
 dnf module install nodejs:<stream> # stream is the version

# Windows (chocolaty)
  cinst nodejs.install

```

- [Yarn](https://classic.yarnpkg.com/en/docs/install/)

```sh
    npm install --global yarn
  ```

- [Git](https://git-scm.com/downloads)

```sh
    # Homebrew
    brew install git

# Sudo apt
    apt-get install git

# Packman
    pacman -S git

# Module Install (Fedora)
    dnf install git

```

### Contribution guidlines 🎃

---

Our Slack Community: [Slack Invite](http://bit.ly/NITRDevs)

`Contributions are welcome 🎉🎉`

### Local Repository Setup

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1.  **Fork** the repo on GitHub
2.  **Clone** the project to your local system
3.  **Commit** changes to your own separate branch
4.  **Push** your work back up to your fork
5.  Submit a **Pull request** so that we can review your changes

NOTE 1: Please abide by the [Contributing Guidelines](https://github.com/dscnitrourkela/project-guava-web/blob/master/CONTRIBUTING.md).

NOTE 2: Please abide by the [Code of Conduct](https://github.com/dscnitrourkela/project-guava-web/blob/master/CODE_OF_CONDUCT.md).

NOTE 3: We follow the following [coventional commit types](https://github.com/pvdlg/conventional-commit-types)

### Running the project.

The project uses Yarn and not NPM. It is strictly advised to stick with Yarn so as to avoid dependency conflicts down the line.

```
## Checkout into the project client directory
cd client

## Install Dependencies
yarn install

## Run the Project
yarn start

```

Following are the commands to remove/add new dependencies using yarn

```
## Add a new Package
yarn add package_name

## Remove an existing Package
yarn remove package_name

## Save Package as a Dev Dependency
yarn add -D package_name
```

## Roadmap

The following project is in its v1 stage. We are open to new features and suggestions. As of now, following are the features that we plan to integrate.

- Set up time of distribution for automatice certificates distributions.
- Complaint management system for disputes.

## License

Distributed under the MIT License. See `LICENSE` for more information.

## DSC NIT Rourkela

[![DSC NIT Rourkela][dsc-nitrourkela]](https://dscnitrourkela.org)

## Starware

dscnitrourkela/project-guava is Starware.
This means you're free to use the project, as long as you star its GitHub repository.
Your appreciation makes us grow and glow up. ⭐

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tr>
 <td align="center"><a href="http://riteshpatil.dev"><img src="https://avatars.githubusercontent.com/u/56112399?v=4?s=100" width="100px;" alt=""/> Ritesh Patil</a> <a href="#maintenance-riteshsp2000" title="Maintenance">🚧</a> <a href="#projectManagement-riteshsp2000" title="Project Management">📆</a> <a href="https://github.com/dscnitrourkela/project-guava-web/commits?author=riteshsp2000" title="Documentation">📖</a> <a href="#ideas-riteshsp2000" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/dscnitrourkela/project-guava-web/commits?author=riteshsp2000" title="Tests">⚠️</a></td>
 <td align="center"><a href="https://github.com/DesignrKnight"><img src="https://avatars.githubusercontent.com/u/27865704?v=4?s=100" width="100px;" alt=""/> Abel Mathew</a> <a href="#ideas-DesignrKnight" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-DesignrKnight" title="Mentoring">🧑‍🏫</a> <a href="#question-DesignrKnight" title="Answering Questions">💬</a> <a href="#security-DesignrKnight" title="Security">🛡️</a></td>
 <td align="center"><a href="https://allcontributors.org"><img src="https://avatars.githubusercontent.com/u/46410174?v=4?s=100" width="100px;" alt=""/> All Contributors</a> <a href="#tool-all-contributors" title="Tools">🔧</a></td>
 <td align="center"><a href="https://github.com/actions"><img src="https://avatars.githubusercontent.com/u/65916846?v=4?s=100" width="100px;" alt=""/> actions-user</a> <a href="#tool-actions-user" title="Tools">🔧</a></td>
 </tr>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

[contributors-shield]: https://img.shields.io/github/contributors/dscnitrourkela/project-guava-web?style=for-the-badge
[contributors-url]: https://github.com/dscnitrourkela/project-guava-web/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/dscnitrourkela/project-guava-web?style=for-the-badge
[forks-url]: https://github.com/dscnitrourkela/project-guava-web/network/members
[stars-shield]: https://img.shields.io/github/stars/dscnitrourkela/project-guava-web?style=for-the-badge
[stars-url]: https://github.com/dscnitrourkela/project-guava-web/stargazers
[issues-shield]: https://img.shields.io/github/issues/dscnitrourkela/project-guava-web?style=for-the-badge
[issues-url]: https://github.com/dscnitrourkela/project-guava-web/issues
[license-shield]: https://img.shields.io/github/license/dscnitrourkela/project-guava?style=for-the-badge
[license-url]: https://github.com/dscnitrourkela/project-guava-web/blob/main/LICENSE.txt
[product-screenshot]: images/Compose.png
[dsc-nitrourkela]: images/repoCover.png

project-guava-web

project-guava-web Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

project-guava-web

project-guava-web Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README