Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turskyi/nextjs-investtrack
InvestTrack - Web and API Backend. A full-stack investment tracking app built with Next.js for managing investments and providing a RESTful API for a mobile app. Features include real-time stock data, CRUD operations, and user authentication. Powered by PostgreSQL, Prisma, and NextAuth.js.
https://github.com/turskyi/nextjs-investtrack
api nextjs typescript web
Last synced: 27 days ago
JSON representation
InvestTrack - Web and API Backend. A full-stack investment tracking app built with Next.js for managing investments and providing a RESTful API for a mobile app. Features include real-time stock data, CRUD operations, and user authentication. Powered by PostgreSQL, Prisma, and NextAuth.js.
- Host: GitHub
- URL: https://github.com/turskyi/nextjs-investtrack
- Owner: Turskyi
- Created: 2024-10-16T01:59:58.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T15:47:17.000Z (about 1 month ago)
- Last Synced: 2024-11-27T16:42:01.428Z (about 1 month ago)
- Topics: api, nextjs, typescript, web
- Language: TypeScript
- Homepage: https://invest.turskyi.com
- Size: 1.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://stand-with-ukraine.pp.ua)
# InvestTrack - Web
This repository contains the Next.js implementation of **InvestTrack**, an
investment tracking platform. The app serves as both a web interface for users
and a backend API for a mobile application. InvestTrack helps users manage and
track their investments across various stocks and provides essential metrics
such as gains, losses, and current market prices.
## Features
- **Investment Dashboard**: View all investments with details such as ticker,
type, stock exchange, currency, and current value.
- **Investment CRUD Operations**: Create, update, and delete investments.
- **Authentication**: User authentication using secure sessions.
- **API for Mobile App**: A RESTful API built using Prisma and exposed via
Next.js API routes for the mobile app to consume.
- **Real-time Data**: Fetch live stock data for current market prices.
- **Responsive Design**: The web interface is fully responsive, ensuring a
seamless experience on both desktop and mobile devices.
## Tech Stack
- **Frontend**: Next.js (React) with Tailwind CSS for styling.
- **Backend**: Next.js API routes.
- **Database**: PostgreSQL (managed via Prisma ORM).
- **Authentication**: NextAuth.js for secure login sessions.
- **Stock Data**: Integrated with a stock market API.
- **Mobile Integration**: Provides a RESTful API to support mobile app
functionality.
## Prerequisites
Before running the application, ensure you have the following installed:
- **Node.js** (v20 or higher)
- **Prisma CLI**: Used to manage migrations and database schema.
## Getting Started
1. **Clone the Repository**:
```bash
git clone https://github.com/Turskyi/nextjs-investtrack.git
cd nextjs-investtrack
```
2. **Install Dependencies**:
Install the required dependencies by running:
```bash
npm install
```
3. Set Up the Database:
You need to set up a PostgreSQL database for the app. Create an `.env` file in
the root directory and add your database URL:
```bash
POSTGRES_URL="postgresql://user:password@localhost:5432/investtrack"
```
4. **Run Database Migrations**:
Apply the Prisma migrations to set up the database schema:
```bash
npx prisma migrate dev
```
5. Seed the Database:
To seed the database with placeholder investment data, run:
```bash
npm run seed
```
6. Start the Development Server:
You can now run the Next.js app in development mode:
```bash
npm run dev
```
The app will be available at http://localhost:3000.
## API Endpoints
The following API routes are exposed for the mobile app:
- **GET /api/investments**: Retrieve a list of all investments.
- **POST /api/investments**: Create a new investment.
- **PUT /api/investments/[id]**: Update an existing investment by ID.
- **DELETE /api/investments/[id]**: Delete an investment by ID.
## Example API Request
To fetch all investments from the Flutter app:
```bash
GET /api/investments
```
## Authentication for API Endpoints
- Authentication is required for accessing API routes.
- Use JWT tokens for authentication in the Flutter app.
- Ensure the token is sent in the Authorization header for secure access.
## Mobile App Integration
The Mobile app consumes the API provided by this Next.js app. Ensure that the
Mobile app is configured to make requests to the correct API endpoint (http://localhost:3000 during development or the production URL).
## Project Structure
```
src/
├── components
│ ├── Badge.tsx
│ ├── InvestmentListItem.tsx
│ └── ui/
├── app
│ ├── fonts/
│ └── layout.tsx
├── assets
│ ├── company-logo-placeholder.jpeg
│ └── logo.png
├── .gitignore
├── next.config.mjs
├── package.json
├── constants.ts # Application-wide constants
└── README.md
```
## Contributing
Feel free to submit issues or pull requests if you'd like to contribute to the
project.
1. Fork the repository
2. Create a new feature branch (git checkout -b feature/your-feature-name)
3. Commit your changes (git commit -am 'Add a new feature')
4. Push the branch (git push origin feature/your-feature-name)
5. Create a Pull Request
## Contact:
For any questions or feedback, please feel free to create an issue in this
repository.
## Screenshot:
## Credits
This project is based on the following resources:
* **Tutorial:** [Learn Next.js 14 Server Actions With This One Project (UseFormStatus, UseFormState, Error Handling)](https://youtu.be/XD5FpbVpWzk?si=V2BUShLowZq3xKAC) by **Coding in Flow** YouTube channel.
* **Project Repository:** [nextjs-job-board](https://github.com/codinginflow/nextjs-job-board/tree/Final-Project) (used in the tutorial) by **Coding in Flow**.
All credit goes to the original author, **Florian Walther** (https://github.com/florianwalther-private). I only followed along and made some minor changes.