Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fatumaa/docs-proj

This project is a documentation application built to document the Unsplash Photos API and the Rick and Morty API. It is built using Astro, Starlight, and Tailwind CSS.
https://github.com/fatumaa/docs-proj

astro docs netlify-deployment starlight starlight-astro tailwindcss

Last synced: about 1 month ago
JSON representation

This project is a documentation application built to document the Unsplash Photos API and the Rick and Morty API. It is built using Astro, Starlight, and Tailwind CSS.

Awesome Lists containing this project

README 

        
![Hero section](/public/hero.png)

![Unsplash example landing page](/public/unsplash-exp.png)



# API Documentation Site



This project is a documentation application built to document the Unsplash Photos API and the Rick and Morty API. The goal is to guide developers and business owners through the use cases and usgae of the APIs. This application is built using Astro, Starlight, and Tailwind CSS.



## Important Links



- [Live site hosted on Netlify](https://docssite-starlight.netlify.app/)

- [Google slides Presentation](https://docs.google.com/presentation/d/1KXCDy0y16HjRTi1fVh-LwKKkis6Hq7v9cL4e8mK_CRU/edit?usp=sharing)



## Table of Contents



- [Project Overview](#project-overview)

- [Features](#features)

- [Technologies Used](#technologies-used)

- [Getting Started](#getting-started)

- [Sections](#sections)

- [Presentation](#presentation)

- [Contributing](#contributing)

- [License](#license)



## Project Overview



This project provides comprehensive documentation for the Unsplash Photos API and the Rick and Morty API. The documentation includes detailed descriptions of the major API endpoints, use cases, and example code snippets. The application features a responsive layout, making it accessible on various devices.



## Features



- **Detailed API Documentation**: Provides information on how to use the Unsplash and Rick and Morty APIs.

- **Responsive Design**: Uses Tailwind CSS to ensure a responsive and modern user interface.

- **Code Examples**: Includes example code snippets to help developers integrate the APIs into their applications.

- **Download Links**: For Unsplash photos, direct download links are provided.



## Technologies Used



- **Astro**: Static site generator for fast and optimized web applications.

- **Starlight**: A documentation theme for Astro, used to create the structured and navigable documentation site.

- **Tailwind CSS**: Utility-first CSS framework for styling the application.

- **Unsplash API**: To fetch and display photos.

- **Rick and Morty API**: To fetch and display information about characters, episodes, and locations from the Rick and Morty TV show.



## Getting Started



### Prerequisites



- Node.js (v14 or later)

- npm or yarn



### Installation



1. Clone the repository:



   ```bash

   git clone https://github.com/FatumaA/docs-proj.git

   cd docs-proj



   ```



1. Install dependencies:



   `npm install` or `yarn install`



### Running the Development Server



`npm run dev` or `yarn dev`



Open http://localhost:4321 in your browser to see the application.



## Sections



- **Home Page**: Introduction to the project and links to various sections.

- **Unsplash API Documentation**: Infrmation on how to use the Unsplash API, including endpoints and parameters.

- **Rick and Morty API Documentation**: Information on how to use the Rick and Morty API, including endpoints and parameters.

- **Example Pages**: Simple landing page consuming the APIs.



## Contributing



Contributions are welcome! Please open an issue or submit a pull request with any improvements or new features.



## License



This project is licensed under the MIT License.