Getting Started
StudyAP is a nonprofit built with Svelte breaking barriers in education through AI generated resources.
Create a new project
To recreate StudyAP, follow these steps:
- Visit the StudyAP Github repository.
- Clone the repository using
git clone https://github.com/studyaporg/studyap - Follow the instructions under the README to install the necessary requirements.
Info
Do not upgrade @opentelemetry/api from version 1.6.0
Detailed Local Setup
After creating your repository, follow these steps to set up the project locally:
Clone your repository:
git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name
Install dependencies:
pnpm install
Start the development server:
pnpm dev
Your development site will be available at http://localhost:5713.
Customizing the Site
StudyAP was built with a mission of providing free educational resources. We encourage you to build your own custom prompts and AI models to generate even more effective questions.
We’ve designed the site to easily add your own AI under the cmd\generator folder.
These packages can be executed directly to generate test questions and pushed to the configured database.
Next Steps
- Dev Variables: Learn about setting up environment variables to use StudyAP’s default features with the Environment Variable guide.
- Configure Default Generation: Learn about how to create custom prompts tailored to any subject with the Configuration guide.
- Deploy: Publish your work with the Hosting guide.