Skip to content

Latest commit

 

History

History
200 lines (156 loc) · 6.73 KB

README.md

File metadata and controls

200 lines (156 loc) · 6.73 KB
Raw

Contributors Forks Stargazers Issues MIT License


Nuevette

Nuevette.ai

A web application that generates customized learning paths on any topic!


View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

alt text alt text

Nuevette is a web application that generates customized learning paths on any topic. By simply entering a topic, users receive a detailed learning path visualized, ready for exploration. It's perfect for anyone looking to streamline their learning journey with a visually structured approach.

(back to top)

Built With

  • Next
  • React
  • TypeScript
  • Tailwind

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Node.js (v14 or later)
  • npm (v6 or later) 
    npm install npm@latest -g

Installation

  1. Clone the repository 
    git clone https://github.com/Sudhanshu-Bharti/nuevette.git
  2. Navigate to the project directory 
    cd nuevette
  3. Install NPM packages 
    npm install
  4. Create a .env file in the root directory and add your API keys: 
    NEXT_PUBLIC_GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"
NEXT_PUBLIC_SERP_API_KEY="YOUR_SERP_API_KEY"

(back to top)

Usage

  1. Start the development server: 
    npm run start
  2. Open your browser and visit http://localhost:3000
  3. Enter a topic in the input field
  4. Click "Generate Learning Path"
  5. Explore your personalized learning path!

(back to top)

Roadmap

  • Add more customization options for learning paths
  • Implement user accounts and saved learning paths
  • Integrate with additional learning resources and platforms
  • Add multi-language support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sudhanshu Bharti - @its_me_shubbb - [email protected]

Project Link: https://github.com/Sudhanshu-Bharti/nuevette

(back to top)

Acknowledgments

(back to top)