This is an app for those who want to make connections and practice languages. Meet a new friend, send digital snail mails and enjoy the experience of sending a letter. 🖊️
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. 💻 You can see a live version of this here.
Clone this repo on your machine and install the dependencies of each folder. 🧪
git clone https://github.com/pedrowindisch/penpals.git
cd penpals
npm install
Don't forget to include your .env file and your Firebase config keys.
Please assure your CWD is your local repo folder. ⚒ Then, start the server by running the following commands:
npm run dev
You can also run only the client or the server of this app. Use the following commands to do so:
npm run client|server
That's all! 💪🏽 Now you can open http://localhost:3000 in your browser and access your local web app. 👏🏽
- React ⚛️ - the front-end framework used.
- styled-components.
- Express - node.js server framework.
- MongoDB - app database.
- npm - dependency management.
- Pedro H. Windisch - concept, design and first steps - @pedrowindisch
- Pierre G. Montelle - @k1tsu
- Mickey E. Mickey - @mickeyeng
See also the list of contributors to see who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details.
We're building this section. 🚧
We're building this section. 🚧
We're building this section. 🚧