Skip to content

Tipper-final-project/Backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to Tipper! 👋

Our cashless tipping web-app! This API allows you to register an account with Tipper, access your account and edit information, as well as receiving messages for any payments.

Install

In order to use this repo and run it locally, you will need to do the following:

  1. Clone the repo from gitHub on your local machine
$ https://github.com/Tipper-final-project/Backend
  1. Install Packages & Dependencies This project uses node version v20.0.0 and npm version 9.6.4 Go check them out if you don't have them locally installed. You can run the command below to install all the necessary packages.
$ npm install

Usage

You will need to make a database with mongodb and once you have made one you will need to get a connection string which is used in the environment.

** IMPORTANT **

You will need to create the necessary environment variables in the top level of your folder

Please create the files:

  1. .env.production
  2. .env.test

Inside the .env.production & .env.test files, add the following variable:

DATABASE_URL={ databse url }

Once the variables have been created, you will need to double check that these .env files are .gitignored. If not, add them to the .gitignored file by writing under node_modules: .env.*

Run Tests

$ npm run test

Authors

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •