Skip to content

Latest commit

 

History

History
156 lines (116 loc) · 3.86 KB

README.md

File metadata and controls

156 lines (116 loc) · 3.86 KB

⚡️Orange Hackathon⚡️

📝 Table of Contents


Built With :


Getting Started

This is a list of needed steps to set up your project locally, to get a local copy up and running follow these instructions.

  1. Clone the repository
    $ git clone https://github.com/Orange-Hackathon/Back-End.git
  2. Navigate to project folder and create file named ".env"
    $ cd Backend & touch .env
  3. Fill ".env" file with these data

    NODE_ENV=development
    PORT=[PORT YOU WANT]
    DATABASE=[CONNECTION STRING OF YOUR DATABASE]
    DATABASE_PASSWORD=[YOUR DATABASE PASSWORD]
    EMAIL_USERNAME=[YOUR EMAIL USERNAME]
    EMAIL_PASSWORD=[EMAIL PASSWORD]
    EMAIL_FROM=[YOUR EMAIL USERNAME]

  4. Install Node js and NPM

    Follow this article to install node js and npm Install Node js and npm

  5. Install dependencies
    $ npm install
  6. Start the application
    $ npm start

API Documentation

You can look on the API documentation at API Documentation


📷 Features

🔒 User Authentication

  • Sign up
  • Login in
  • Forget PIN

🙍‍♂️Transactions

  • Send Money to friends
  • Payments
  • Bills

Contributors

AhmedLotfy02
Ahmed Lotfy

🔒 License

This software is licensed under MIT License, See License .