Code Monkey home page Code Monkey logo

integration-project's Introduction

icon

Contributors Forks Stargazers Issues MIT License LinkedIn


icon logo

< Rick & Morty Characters App >

This is my first integration project developed at Henry.The first month of the course marked my introduction to Javascript and other new technologies such as data structures, algorithms, React, Redux, promises, Express, testing, SQL, ORM, and Sequelize.

The project centers around leveraging an API to present characters from the Rick and Morty TV series. Users can explore characters, add them to favorites, and access detailed information.
๐Ÿ“‚ Explore the documents ยป

Initial release ยท Report bug ยท Request feature

Contents โ†ด
  1. Built with
  2. Description
  3. Preparation
  4. Roadmap
  5. Contributions
  6. Acknowledgments
  7. License
  8. Contact

( โ–ณ )

๐Ÿ“Œ Built with:


React

Redux

Node

Nodemon

Express

Sequelize

CSS

GitHub

  • for the app versioning

( โ–ณ )

โ–ท Description ๐Ÿ“œ

This project is a SPA (Single Page Application) that consumes an API (https://rickandmortyapi.com/) in which you can:

  • Search for characters.
  • Display the information of the characters.
  • Filter them.
  • Order them.

The goals of this project are to:

  • Build a Single Page Application using the technologies: React, Redux, Node, Express and Sequelize.
  • Put into practice basic style and design resources (UX: UI).
  • Affirm and connect the concepts learned thus far.
  • Learn best practices.
  • Learn and practice the GIT workflow.
  • Use and practice testing.

โ–ท Client/front-end: โ‹„ click here โ‹„

โ–ท Server/back-end link: โ‹„ click here โ‹„

โ–ท Project visualization :


Login ๐Ÿ”Ž

visualization

Login mobile ๐Ÿ”Ž

visualization

Home ๐Ÿ”Ž

visualization

Home mobile ๐Ÿ”Ž

visualization

Character details ๐Ÿ”Ž

visualization

Character details mobile ๐Ÿ”Ž

visualization

About ๐Ÿ”Ž

visualization

icon

( โ–ณ )

๐Ÿ“Œ Preparation

To get a working local copy, I followed these steps:

โœ”๏ธ Requirements


  • Install Node Package Manager. Node Package Manager (npm) is a software repository for JavaScript packages. You can download it โ‹„ here โ‹„

It is necessary to have at least the latest stable version of NodeJS and NPM. Make sure you have it so you can correctly install the dependencies needed to run the project. Currently the required versions are:

  • Node: 12.18.3 or higher
  • NPM: 6.14.16 or higher

To check which version you have installed:

node -v
npm -v

โœ”๏ธ Installation


  • Clone the project locally.

    git clone https://github.com/hebelia/Integration-Project.git
  • Install npm packages.

    npm install
  • If you find any vulnerability reports, fix them with:

    npm audit fix
  • Run the server in the terminal (back-end)

    npm start
  • Run the client in the terminal and open it in a browser.

    npm run dev

( โ–ณ )

โ–ท Roadmap ๐Ÿ”–


โœ”๏ธ Enter with username/mail and password to access the web application
โœ”๏ธ Show information fetched from consumed API
โœ”๏ธ Add and remove characters to the list
โœ”๏ธ Add and remove characters to the favorites list
โœ”๏ธ Generate random characters
โœ”๏ธ Responsive design



โ–ท Contributions ๐Ÿ’ก

Contributions and suggestions are what make the open source community such an amazing place to learn, inspire, and create. As I am starting my journey in programming any contribution you make is greatly appreciated ๐Ÿ˜„
๐Ÿ“Œ Pushpins to the repository can be done by forking and doing a pull request or by simply opening an "issue" with the tag "improvement".

Suggestions: โ‹„ click here โ‹„ see the full list of proposed features (and known issues).

( โ–ณ )

โ–ท License ยฉ๏ธ


< Copyright ยฉ 2023 Hebe Lia Romeu >


โ—‡ ย  Connect with me ย  ๐Ÿ“ฌ

hebeliaromeu hebe.lia Email Me hebelia

( โ–ณ )

integration-project's People

Contributors

hebelia 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.