Skip to content

johnggli/ToDo_API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

☑️ ToDo API

REST API made with Node.js, MongoDB and Heroku.

GitHub top language Node version npm version Made by Repository size GitHub last commit

About the project   |    Technologies   |    Getting started   |    How to contribute   |    Get in touch


💡 About the project

  • This project is about a REST API made in JavaScript, using Node.JS and MongoDB for the construction of the database, and hosted/deployed on the Heroku website.

🚀 Technologies

Technologies that I used to develop this project

💻 Getting started

Requirements

Clone the project and access the folder

$ git clone https://github.com/johnggli/ToDo_API.git

Follow the steps below

# Starting from the project root folder
$ cd ToDo_API

# Install the dependencies
$ npm install

# Find the following part of the code in src/app.js
database() {
    mongoose.connect(process.env.MONGO_URI, { useNewUrlParser: true, useUnifiedTopology: true })
    mongoose.connection.on('error', function() {
        console.log('Erro ao conectar-se ao BD')
    })
}

# Replace the *process.env.MONGO_URI* variable with the connection string of your MongoDB database
# to something like this: "mongodb+srv:https://<user>:<password>@tododb-txqgj.gcp.mongodb.net/<dbname>"

# Save changes, then Start the server with:
$ npm start

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork johnggli/ToDo_API

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd ToDo_API

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

🌟 Extras


Made with ♥ by John Emerson 👋 Get in touch

Releases

No releases published

Packages

No packages published