Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/manuel-heav/inxtract

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/manuel-heav/inxtract
Owner: Manuel-heav
License: mit
Created: 2024-07-08T12:22:24.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-07-21T13:00:36.000Z (4 months ago)
Last Synced: 2024-07-21T20:03:18.928Z (4 months ago)
Language: TypeScript
Homepage: https://inxtract.vercel.app
Size: 1.76 MB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Inxtract

## Introduction

Inxtract is an application designed to summarize research papers and articles efficiently. It provides users with a secure and intuitive platform to manage and update summaries, facilitating collaboration and enhancing productivity.

## Screenshots

![Screenshot 1](/Screenshots/1.png)
![Screenshot 2](/Screenshots/2.png)
![Screenshot 3](/Screenshots/3.png)
![Screenshot 4](/Screenshots/4.png)
![Screenshot 5](/Screenshots/5.png)

## Features

- [x] Secure Authentication
- [x] Great Dashboard
- [x] Article Summary
- [x] Summary Update
- [ ] Collaboration with Team

## Technologies

Frontend: Next.js + Tailwind CSS
Backend: .NET

## Installation

To get started with Inxtract, follow these steps:

Clone the repository:

```bash
git clone https://github.com/yourusername/inxtract.git
```

Navigate to the project directory:

```bash
cd inxtract
```

Install frontend dependencies:

```bash
cd frontend
npm install
```

Install backend dependencies:

```bash
cd backend
dotnet restore
```

Usage
To run the application locally:

Start the backend server:

```bash
cd backend
dotnet run
```

Start the frontend server:

```bash
cd frontend
npm run dev
```

Open your browser and go to http://localhost:3000 to see the application in action.

Configuration
Inxtract requires specific environment variables for configuration. Create a .env file in both the frontend and backend directories and add the necessary variables as shown in the .env.example files.

## Examples

Here are some examples of how to use Inxtract:

Summarizing an Article:

Upload the article or provide a link.
Click on the "Analyze" button.
View the summary on the dashboard.
Updating a Summary:

Select the summary you want to update.
Click on the "Update" button.
Make the necessary changes and save.
Troubleshooting
If you encounter any issues, refer to the troubleshooting guide.

## Contributors

- Amanuael Kebede
- Eyoel Melkamu
- Mohammed Shemim
- Abdulkerim Seid

License
Inxtract is licensed under the MIT License. See the [LICENSE](/LICENSE.txt) file for more details.