Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 2.03 KB

README.md

File metadata and controls

105 lines (72 loc) · 2.03 KB

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 Screenshot 2 Screenshot 3 Screenshot 4 Screenshot 5

Features

  • Secure Authentication
  • Great Dashboard
  • Article Summary
  • 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:

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

Navigate to the project directory:

cd inxtract

Install frontend dependencies:

cd frontend
npm install

Install backend dependencies:

cd backend
dotnet restore

Usage To run the application locally:

Start the backend server:

cd backend
dotnet run

Start the frontend server:

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 file for more details.