Skip to content

Commit

Permalink
added readme.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Panther-12 committed Jun 12, 2024
1 parent 50916d7 commit 1607578
Showing 1 changed file with 117 additions and 0 deletions.
117 changes: 117 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Ionic Gallery and LinkedIn Sharing App

## Table of Contents
- [Ionic Gallery and LinkedIn Sharing App](#ionic-gallery-and-linkedin-sharing-app)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Features](#features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Usage](#usage)
- [Configuration](#configuration)
- [LinkedIn API Integration](#linkedin-api-integration)
- [Project Structure](#project-structure)
- [Dependencies](#dependencies)
- [Contributing](#contributing)
- [License](#license)
- [Explanation](#explanation)

## Introduction
This Ionic application provides a gallery view for images and a feature to share content directly to LinkedIn. It includes multiple tabs for navigating through the app.

## Features
- Home tab with introductory content.
- Gallery tab displaying a collection of images.
- Share tab allowing users to post content directly to LinkedIn.

## Screenshots
![Home Tab](https://i.pinimg.com/736x/e5/5e/f7/e55ef76557ab265faf325735e362acf4.jpg)
![Gallery Tab](https://i.pinimg.com/736x/de/d3/88/ded3885dacca6f0251ec91b56dada499.jpg)
![Share Tab](https://i.pinimg.com/736x/c4/e7/21/c4e721fb99814c442e014844689ed20c.jpg)

## Installation

### Prerequisites
- [Node.js](https://nodejs.org/)
- [Ionic CLI](https://ionicframework.com/docs/cli)

### Steps
- Clone the repository:
```bash
git clone https://github.com/yourusername/ionic-gallery-linkedin.git
```
- Navigate to the project directory:
```bash
cd ionic-gallery-linkedin
```
- Install the dependencies:
```bash
npm install
```

### Usage
- Start the development server:
```bash
ionic serve
```
- Open your browser and navigate to http://localhost:8100.

### Configuration
#### LinkedIn API Integration
1. Register your app on the LinkedIn Developer Portal.

2. Obtain the client ID, client secret, and access token.

3. Replace YOUR_ACCESS_TOKEN and YOUR_PERSON_URN in share.page.ts with your actual LinkedIn access token and person URN.

### Project Structure
`tabs.page.html`: Main navigation structure with tabs.
`home.page.html / home.page.scss / home.page.ts`: Home tab implementation.
`gallery.page.html / gallery.page.scss / gallery.page.ts`: Gallery tab implementation.
`share.page.html / share.page.scss / share.page.ts`: Share tab implementation with LinkedIn integration.

### Dependencies
```
@angular/core
@angular/common/http
@ionic/angular
rxjs
```
### Contributing
- Fork the repository.
- Create a new branch (`git checkout -b feature-branch`).
- Make your changes.
- Commit your changes (`git commit -am 'Add new feature'`).
- Push to the branch (`git push origin feature-branch`).\
- Create a new Pull Request
.
### License
This project is licensed under the MIT License - see the LICENSE file for details.
### Explanation
- **Introduction**: Brief overview of the application.
- **Features**: Highlights the main features.
- **Screenshots**: Placeholder for screenshots of different tabs.
- **Installation**: Instructions to clone the repo and install dependencies.
- **Usage**: Steps to start the development server.
- **Configuration**: Details on setting up LinkedIn API integration.
- **Project Structure**: Overview of the main files and their purposes.
- **Dependencies**: Lists the main dependencies used in the project.
- **Contributing**: Guidelines for contributing to the project.
- **License**: Information about the project's license.
Feel free to adjust the paths, links, and other details to match your actual project.

0 comments on commit 1607578

Please sign in to comment.