Skip to content

README.md

Latest commit

 

History

History
124 lines (90 loc) · 3.22 KB

README.md

File metadata and controls

124 lines (90 loc) · 3.22 KB

Pump.fun API

Pump.fun API is a web application designed to track updates, new tokens, and users' personal tokens they hold or launch. The backend is built using Node.js, Express, Cheerio, and Axios, while the frontend is developed with Angular.

Table of Contents

Features

  • Track updates on new tokens
  • Monitor users' personal tokens
  • Web scraping for token data
  • Secure user authentication using JWT
  • RESTful API endpoints
  • Responsive frontend using Angular

Architecture

  • Frontend: Angular
  • Backend: Node.js, Express
  • Database: MongoDB
  • Web Scraping: Cheerio
  • HTTP Requests: Axios
  • Authentication: JSON Web Tokens (JWT)

Installation

Prerequisites

  • Node.js and npm
  • MongoDB

Backend Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/pump-fun-api.git
cd pump-fun-api

  2. Install backend dependencies:

    npm install

  3. Create a .env file in the root directory with the following variables:

    PORT=5000
MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret

  4. Start the backend server:

    npm start

Frontend Setup

  1. Navigate to the frontend directory:

    cd frontend

  2. Install frontend dependencies:

    npm install

  3. Open your browser and visit http://localhost:4200.

Usage

  • Access the API endpoints to manage user and token data.
  • Use the Angular frontend to interact with the API and visualize token information.

API Endpoints

User Management

  • GET /api/users: Retrieve all users
  • POST /api/users: Create a new user
  • GET /api/users/:id: Retrieve a specific user
  • PUT /api/users/:id: Update a specific user
  • DELETE /api/users/:id: Delete a specific user

Token Management

  • GET /api/tokens: Retrieve all tokens
  • POST /api/tokens: Create a new token
  • GET /api/tokens/:id: Retrieve a specific token
  • PUT /api/tokens/:id: Update a specific token
  • DELETE /api/tokens/:id: Delete a specific token

Security

  • User authentication is implemented using JSON Web Tokens (JWT).
  • HTTPS is recommended for secure data transmission.
  • Input validation and sanitization are applied to prevent injection attacks.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for review.

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature
  3. Commit your changes: git commit -m 'Add your feature'
  4. Push to the branch: git push origin feature/your-feature
  5. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.


This `README.md` provides a comprehensive guide to setting up, using, and contributing to the Pump.fun API project. You can further customize it to align with your project's specific details and requirements.