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

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License

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
• TypeScript
• Node.js
• JavaScript
• MongoDB
• Express.js
• Sass
• DocuSign

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

We strictly use yarn for managing the packages/dependencies of the React app. You need to install yarn to successfully run this project locally.

• npm

  npm install npm@latest -g

• yarn

  npm install -g yarn

Installation

1. Fork the project first

2. Clone the forked repo

   git clone https://github.com/your_name/Smile-E.git

3. Go to server directory, create a .env file and install the packages using

   CONNECTION_URL = "MongoDB URL"

   cd server
   npm install

   Run the server locally using

   npm start

4. Go to client directory, create a .env file

   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

   yarn

   or

   yarn install

5. Run the app in the development mode using

   yarn start

   Open 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 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 for more information.