https://github.com/niloysikdar/smile-e
A one-stop solution for an easy, digital, and trusted flow of agreement for NGOs using eSignature. Added a dedicated Dashboard section to showcase the NGOs’ past works for easy fundraising.
https://github.com/niloysikdar/smile-e
docusign-api expressjs javascript mongodb nodejs reactjs sass typescript
Last synced: 3 months ago
JSON representation
A one-stop solution for an easy, digital, and trusted flow of agreement for NGOs using eSignature. Added a dedicated Dashboard section to showcase the NGOs’ past works for easy fundraising.
- Host: GitHub
- URL: https://github.com/niloysikdar/smile-e
- Owner: niloysikdar
- License: bsd-3-clause
- Created: 2021-08-06T18:14:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-14T13:03:41.000Z (about 4 years ago)
- Last Synced: 2025-05-18T00:40:13.683Z (10 months ago)
- Topics: docusign-api, expressjs, javascript, mongodb, nodejs, reactjs, sass, typescript
- Language: TypeScript
- Homepage: https://smile-e.vercel.app
- Size: 6.84 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Smile-E
A one-stop solution for an easy, digital, and trusted flow of agreement for NGOs using eSignature
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
### A one-stop solution for an easy, digital, and trusted flow of agreement for NGOs using eSignature.
### Also it has a dedicated Dashboard section to showcase the NGOs’ past works for easy fundraising.
### Built With
- [React](https://reactjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Node.js](https://nodejs.org/en/)
- [JavaScript](https://www.javascript.com/)
- [MongoDB](https://www.mongodb.com/)
- [Express.js](https://expressjs.com/)
- [Sass](https://sass-lang.com/)
- [DocuSign](https://developers.docusign.com/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
**_We strictly use [yarn](https://yarnpkg.com/) for managing the packages/dependencies of the React app. You need to install [yarn](https://yarnpkg.com/) to successfully run this project locally._**
- npm
```sh
npm install npm@latest -g
```
- yarn
```sh
npm install -g yarn
```
### Installation
1. Fork the project first
2. Clone the forked repo
```sh
git clone https://github.com/your_name/Smile-E.git
```
3. Go to `server` directory, create a `.env` file and install the packages using
```sh
CONNECTION_URL = "MongoDB URL"
```
```sh
cd server
npm install
```
Run the `server` locally using
```sh
npm start
```
4. Go to `client` directory, create a `.env` file
```sh
REACT_APP_INTEGRATION_KEY = "DocuSign Integration Key"
REACT_APP_ACCOUNT_ID = "DocuSign Account Id"
REACT_APP_ADMIN_USERNAME = "DocuSign Account Username"
REACT_APP_ADMIN_PASSWORD = "DocuSign Account Password"
```
Install the packages using
```sh
yarn
```
or
```sh
yarn install
```
5. Run the app in the development mode using
```sh
yarn start
```
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
## Screenshots
## Roadmap
See the [open issues](https://github.com/niloysikdar/Smile-E/issues) for a list of proposed features (and known issues). Feel free to raise new issues.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch ( `git checkout -b feature/AmazingFeature` )
3. Add your Changes ( `git add .` )
4. Commit your Changes ( `git commit -m 'Add some AmazingFeature'` )
5. Push to the Branch ( `git push origin feature/AmazingFeature` )
6. Open a Pull Request
## License
Distributed under the **BSD 3-Clause License**. See [`LICENSE`](https://github.com/niloysikdar/Smile-E/blob/main/LICENSE) for more information.