Introduction

Welcome to CodeCup! This documentation will guide you through the process of getting started and making the most out of our platform.

CodeCup Dashboard

Account Creation

To start using CodeCup, follow these steps:

  1. Go to the CodeCup website.
  2. Click on the "Sign Up" button.
  3. Fill in the required information (username, email, password).
  4. Click "Create Account" and verify your email address.
Sign Up Form

Using the Editor

Once you have created an account and logged in, you can start writing code:

  1. Navigate to the editor by clicking on "New Snippet" in the main menu.
  2. Select the type of snippet you want to create (HTML, CSS, JavaScript).
  3. Start writing your code in the respective editors.
Code Editor

Saving Snippets

To save your code snippets:

  1. After writing your code, click on the "Save" button at the top of the editor.
  2. Provide a title and description for your snippet.
  3. Click "Save Snippet" to store your code in your account.
Save Snippet

API

CodeCup offers several API endpoints:

  • /api/getProjects - Retrieves all projects for a user.
  • /api/saveProject - Saves a new project.
API Endpoints

FAQ

Commonly asked questions:

  • Q: How do I save a project?
    A: Use the /api/saveProject endpoint to save your project.
  • Q: How do I retrieve my projects?
    A: Use the /api/getProjects endpoint to get a list of your projects.
FAQ

Contact

If you have any questions, feel free to contact us at support@codecup.com.

Contact