RafaelBahiense / Pokedex-Backend

A simple and lightweight pokédex api, Typescript and TypeORM

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Backend

Pokédex - Gotta catch them all

A simple and lightweight pokédex, Typescript and TypeORM

Click here to acess the App

About

This is an web application with which lots of people can track their Pokédex completion and Pokémons infos. Below are the implemented features:

  • Sign Up
  • Login
  • List all pokémons
  • Add Pokémon
  • Remove Pokémon
  • List my pokémons

Project repo

Technologies

The following tools and frameworks were used in the construction of the project:

NodeJS ExpressJS TypeScript TypeORM

Node

Express

Typescript

TypeOrm

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications TypeScript is an open-source language which builds on JavaScript, one of the world’s most used tools, by adding static type definitions TypeORM is an ORM that can run in NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms and can be used with TypeScript and JavaScript (ES5, ES6, ES7, ES8)

How to run

  1. Clone this repository
  2. Clone the Frontend repository
  3. Follow instructions to run the Frontend
  4. Install dependencies
npm i
  1. Create a PostgresSQL database "your_database_dev" and "your_database_test"
  2. rename example.local.dev.env -> local.dev.env and example.local.test.env -> local.test.env
  3. Config .env files as indicated
  4. Run the Backend with
npm run dev
  1. Finally access http://localhost:4000/api/"desired-route" on your favorite API Client or run the Frontend and access http://localhost:3000 on your favorite browser

About

A simple and lightweight pokédex api, Typescript and TypeORM

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:TypeScript 97.3%Language:Shell 2.5%Language:JavaScript 0.2%