Table of Contents

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

About The Project

DittoData allows developers to create dummy data.

(back to top)

Built With

• React.js
• React Hash Router
• Express
• Node.js
• Material UI
• PostgreSQL
• Passport.js
• Supertest

(back to top)

Getting Started

Prerequisites

• npm

  npm install

Installation

1. Get a free ElephantSQL URI from https://www.elephantsql.com/ and Google OAuth Client ID / Client Secret from https://console.cloud.google.com/apis/credentials.

2. Clone the repo

   git clone https://github.com/PseudoDD/DittoData.git

3. Install NPM packages

   npm install

4. Create .env in the root directory and enter your Database URI, Google Client ID, and Google Client Secret

   const DB_KEY = 'ENTER YOUR ELEPHANTSQL URI';
   const GOOGLE_CLIENT_ID = 'ENTER YOUR GOOGLE CLIENT ID';
   const GOOGLE_CLIENT_SECRET = 'ENTER YOUR GOOGLE CLIENT SECRET';

(back to top)

Roadmap

• Creating database.
• Implement OAuth.
• Standardize field types.
• Create mock data algos.
• Implement testing with Supertest.
• Implement testing with Jest.

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Bruno Albero - LinkedIn - alberobruno@gmail.com
Michael Negron - LinkedIn - michaelnegronaudio@gmail.com
Sinian Ma - LinkedIn - nycsinian@gmail.com
Stanley Chen - LinkedIn - stanchenw@gmail.com

DittoData: https://github.com/PseudoDD/DittoData.gita

(back to top)