Git Product home page Git Product logo

pokedexapi's Introduction

pokedexAPI

License: MIT


Technology Used πŸ–₯️

Technology Used Resource URL
JavaScript https://developer.mozilla.org/en-US/docs/Web/JavaScript
node.js https://nodejs.org/en
Express.js https://expressjs.com/
dotenv https://www.npmjs.com/package/dotenv
nodemon https://www.npmjs.com/package/nodemon
Mongoose https://mongoosejs.com/
MongoDB https://www.mongodb.com/
Git https://git-scm.com/

Description πŸ“

Track your Pokemon, create relationships between them, and create thoughts for them all in one application. Through the utilization of MongoDB, Mongoose, and Express.js, this application is able to create, read, update, and delete information between Pokemon and all of the information is stored in a MongoDB backend thanks to the usage of Mongoose.

example.gif


Table of Contents πŸ“‹


Learning Points ✍️

The benefit of using Mongoose/MongoDB in this application compared to other backend databases like MySQL is that due to the sheer size of Pokemon entries in the National Pokedex (over 1000), if a user was enthusiastic enough to put in all of the existing, and to be created, Pokemon into the database, manipulating data would be much faster compared to MySQL.

Of course, there's also downsides of using MongoDB as a backend, such as, the lack of strict data validations like there are in MySQL and the relational pairings that data entries can have with one another.


Installation Instructions πŸ“₯

To install this app, follow the instructions below:

  1. Make sure you have Node.js installed on your computer.
  2. Download/clone the contents of this repo on to your local machine.
  3. Open your integrated terminal in the root directory of this app.
  4. Run npm i or npm install in your terminal to download all of the dependencies.

Usage Information βœ…

To use this application, follow the steps below:

  1. Make sure you have installed all of the dependencies.
  2. Run npm start in the terminal that's opened to the root directory of this app.
  3. Make get, post, put, and delete requests to http://localhost:3001/api/pokemon or http://localhost:3001/api/thought to get started filling your database with information. For more specific route details, please follow the tutorial video below.

If you'd like to see a tutorial video and demo of all of the routes that are available in this application, please click here to watch the demo video.


Contribution Guidelines 🀝

If you'd like to contribute to this project, simply open a PR and I'll have a look at it!. Furthermore, if you'd like to become a dedicated contributor, message me on any of my socials linked in the author info section or email me at [email protected]


Author Info πŸ‘Ί

daevidvo


Questions ❓

Email me at: [email protected] or visit my GitHub


License 🚩

https://opensource.org/licenses/MIT

The MIT License (MIT)

Copyright Β© daevidvo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the β€œSoftware”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED β€œAS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pokedexapi's People

Contributors

daevidvo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.