Table of Contents
To get a local copy up and running follow these simple steps.
-
Get a free API Key at https://www.deepl.com/en/docs-api/
-
Clone the repo
git clone https://github.com/babel-on/penpals.git
-
Install NPM packages
npm install
-
Create .env file at root of directory
-
Enter your API in
.envDEEPL_KEY='ENTER YOUR API';
-
Connect MongoDB Atlas database in
.envMONGO_URI='YOUR MONGO URI STRING';
-
Set up JWT secret in
.envJWT_KEY='your string of choice';
Sign up for an account, and talk to users across the world! Penpals automatically translates incoming messages to the language of your choice. Multilingual and want to change languages? No problem. Penpals will also store your previous messages and re-translate them to your new language.
- Minimum Viable Product Release
- Websocket implementation
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Michael Sarkisian - GitHub
Jigar Patel - GitHub
James Chan - GitHub
Adrian Reczek - LinkedIn - adrianwreczek@gmail.com
Project Link: https://github.com/babel-on/penpals