Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osmanjimenez/rick-and-morty
Aplicación contruida en angular y ionic que consume un api con contenido de rick and morty
https://github.com/osmanjimenez/rick-and-morty
angular html5 ionic scss typescript
Last synced: about 1 month ago
JSON representation
Aplicación contruida en angular y ionic que consume un api con contenido de rick and morty
- Host: GitHub
- URL: https://github.com/osmanjimenez/rick-and-morty
- Owner: OsmanJimenez
- Created: 2023-03-18T17:02:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T13:49:03.000Z (9 months ago)
- Last Synced: 2024-11-05T23:27:22.273Z (3 months ago)
- Topics: angular, html5, ionic, scss, typescript
- Language: TypeScript
- Homepage: https://osmanjimenez.github.io/rick-and-morty/
- Size: 936 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
RICK-AND-MORTY
Developed with the software and tools below.
## 🔗 Quick Links
> - [📍 Overview](#-overview)
> - [📦 Features](#-features)
> - [📂 Repository Structure](#-repository-structure)
> - [🧩 Modules](#-modules)
> - [🚀 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🤖 Running rick-and-morty](#-running-rick-and-morty)
> - [🧪 Tests](#-tests)
> - [🛠 Project Roadmap](#-project-roadmap)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
> - [👏 Acknowledgments](#-acknowledgments)
---
## 📍 Overview
`overview`
---
## 📦 Features
`features`
---
## 📂 Repository Structure
```sh
└── rick-and-morty/
├── README.md
├── angular.json
├── capacitor.config.ts
├── ionic.config.json
├── karma.conf.js
├── package-lock.json
├── package.json
├── src
│ ├── app
│ │ ├── app-routing.module.ts
│ │ ├── app.component.html
│ │ ├── app.component.scss
│ │ ├── app.component.spec.ts
│ │ ├── app.component.ts
│ │ ├── app.module.ts
│ │ ├── pages
│ │ │ └── home
│ │ │ ├── home-routing.module.ts
│ │ │ ├── home.module.ts
│ │ │ ├── home.page.html
│ │ │ ├── home.page.scss
│ │ │ ├── home.page.spec.ts
│ │ │ └── home.page.ts
│ │ └── services
│ │ └── api
│ │ ├── api.service.spec.ts
│ │ ├── api.service.ts
│ │ ├── endpoint.service.spec.ts
│ │ └── endpoints.service.ts
│ ├── assets
│ │ ├── icon
│ │ │ └── favicon.png
│ │ ├── img
│ │ │ └── logo.png
│ │ └── shapes.svg
│ ├── environments
│ │ ├── environment.prod.ts
│ │ ├── environment.ts
│ │ └── version.ts
│ ├── global.scss
│ ├── index.html
│ ├── main.ts
│ ├── polyfills.ts
│ ├── test.ts
│ ├── theme
│ │ └── variables.scss
│ └── zone-flags.ts
├── tsconfig.app.json
├── tsconfig.json
└── tsconfig.spec.json
```
---
## 🧩 Modules
.
| File | Summary |
| --- | --- |
| [tsconfig.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/tsconfig.json) | `tsconfig.json` |
| [tsconfig.app.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/tsconfig.app.json) | `tsconfig.app.json` |
| [ionic.config.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/ionic.config.json) | `ionic.config.json` |
| [tsconfig.spec.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/tsconfig.spec.json) | `tsconfig.spec.json` |
| [angular.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/angular.json) | `angular.json` |
| [package.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/package.json) | `package.json` |
| [karma.conf.js](https://github.com/OsmanJimenez/rick-and-morty/blob/master/karma.conf.js) | `karma.conf.js` |
| [capacitor.config.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/capacitor.config.ts) | `capacitor.config.ts` |
| [package-lock.json](https://github.com/OsmanJimenez/rick-and-morty/blob/master/package-lock.json) | `package-lock.json` |
src
| File | Summary |
| --- | --- |
| [polyfills.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/polyfills.ts) | `src/polyfills.ts` |
| [index.html](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/index.html) | `src/index.html` |
| [zone-flags.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/zone-flags.ts) | `src/zone-flags.ts` |
| [test.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/test.ts) | `src/test.ts` |
| [main.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/main.ts) | `src/main.ts` |
| [global.scss](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/global.scss) | `src/global.scss` |
src.environments
| File | Summary |
| --- | --- |
| [environment.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/environments/environment.ts) | `src/environments/environment.ts` |
| [environment.prod.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/environments/environment.prod.ts) | `src/environments/environment.prod.ts` |
| [version.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/environments/version.ts) | `src/environments/version.ts` |
src.theme
| File | Summary |
| --- | --- |
| [variables.scss](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/theme/variables.scss) | `src/theme/variables.scss` |
src.app
| File | Summary |
| --- | --- |
| [app-routing.module.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/app-routing.module.ts) | `src/app/app-routing.module.ts` |
| [app.component.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/app.component.ts) | `src/app/app.component.ts` |
| [app.component.scss](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/app.component.scss) | `src/app/app.component.scss` |
| [app.component.spec.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/app.component.spec.ts) | `src/app/app.component.spec.ts` |
| [app.component.html](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/app.component.html) | `src/app/app.component.html` |
| [app.module.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/app.module.ts) | `src/app/app.module.ts` |
src.app.services.api
| File | Summary |
| --- | --- |
| [api.service.spec.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/services/api/api.service.spec.ts) | `src/app/services/api/api.service.spec.ts` |
| [api.service.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/services/api/api.service.ts) | `src/app/services/api/api.service.ts` |
| [endpoint.service.spec.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/services/api/endpoint.service.spec.ts) | `src/app/services/api/endpoint.service.spec.ts` |
| [endpoints.service.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/services/api/endpoints.service.ts) | `src/app/services/api/endpoints.service.ts` |
src.app.pages.home
| File | Summary |
| --- | --- |
| [home.page.spec.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/pages/home/home.page.spec.ts) | `src/app/pages/home/home.page.spec.ts` |
| [home.page.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/pages/home/home.page.ts) | `src/app/pages/home/home.page.ts` |
| [home-routing.module.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/pages/home/home-routing.module.ts) | `src/app/pages/home/home-routing.module.ts` |
| [home.page.scss](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/pages/home/home.page.scss) | `src/app/pages/home/home.page.scss` |
| [home.module.ts](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/pages/home/home.module.ts) | `src/app/pages/home/home.module.ts` |
| [home.page.html](https://github.com/OsmanJimenez/rick-and-morty/blob/master/src/app/pages/home/home.page.html) | `src/app/pages/home/home.page.html` |
---
## 🚀 Getting Started
***Requirements***
Ensure you have the following dependencies installed on your system:
- **TypeScript**: `version x.y.z`
### ⚙️ Installation
1. Clone the rick-and-morty repository:
```sh
git clone https://github.com/OsmanJimenez/rick-and-morty
```
2. Change to the project directory:
```sh
cd rick-and-morty
```
3. Install the dependencies:
```sh
npm install
```
### 🤖 Running rick-and-morty
Use the following command to run rick-and-morty:
```sh
npm run build && node dist/main.js
```
### 🧪 Tests
To execute tests, run:
```sh
npm test
```
---
## 🛠 Project Roadmap
- [X] `► INSERT-TASK-1`
- [ ] `► INSERT-TASK-2`
- [ ] `► ...`
---
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/OsmanJimenez/rick-and-morty/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/OsmanJimenez/rick-and-morty/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/OsmanJimenez/rick-and-morty/issues)**: Submit bugs found or log feature requests for Rick-and-morty.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone https://github.com/OsmanJimenez/rick-and-morty
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---
## 👏 Acknowledgments
- List any resources, contributors, inspiration, etc. here.
[**Return**](#-quick-links)
---