Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexandraC0 committed Sep 11, 2023
1 parent 42f64e7 commit 0c85545
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# GraphQL Security Academy by Escape.tech
# API Security Academy by Escape.tech

## What is it?

GraphQL Security Academy provides hands-on, interactive lessons that teach various vulnerabilities and best practices in GraphQL security directly in your browser. Each lesson features a WebContainer with a live GraphQL application, demonstrating not just the risks but also how to exploit and fix them.
API Security Academy provides hands-on, interactive lessons that teach various vulnerabilities and best practices in GraphQL security. Discover its full learning potential directly in your browser. Each lesson features a WebContainer with a live GraphQL application, demonstrating not just the risks but also how to **exploit** and **fix** them.

> 💡 The GraphQL Security Academy is accessible for free on https://escape.tech/academy
> 💡 The [API Security Academy](https://www.escape.tech/academy?utm_source=github&utm_medium=social&utm_campaign=description-call-out) is accessible for free. We initially chose to prioritize GraphQL, as it’s at the core of our expertise, but anticipate introducing additional API types in the future!
## Why Use GraphQL Security Academy?
## Why learn with API Security Academy?

- 📚 Comprehensive Lessons: Covering everything from basic to advanced GraphQL security topics.
- 📚 Comprehensive lessons: Covering everything from basic to advanced GraphQL security topics.
- 💻 Interactive: Each lesson includes a WebContainer for a real-world experience.
- 🧑‍💻 For Developers and Security Engineers: Whether you're building or securing GraphQL apps, there's something to learn.
- 🧑‍💻 For Developers and Security Engineers: Whether you're building or securing GraphQL apps, there's always more to explore and learn.
- 🆓 Free and Open Source: Learn at your own pace, and even contribute to make it better!

## Features

- 🌐 Browser-Based Learning: No downloads, no installs. Start learning immediately right within your browser.
- 🛠 Hands-On Experience: Apply what you've learned in real-world GraphQL app scenarios.
- 🌐 Browser-Based learning: no downloads, installs, or account creation. Start learning immediately right within your browser.
- 🛠 Hands-on experience: apply your knowledge in real-world GraphQL app scenarios.

## How to Contribute
## How to contribute

We're thrilled that you're interested in contributing to the GraphQL Security Academy! Contributions are essential for keeping this project informative, up-to-date, and most importantly, beneficial for everyone interested in GraphQL security.
We're thrilled that you're interested in contributing to the API Security Academy! Contributions are essential for keeping this project informative, up-to-date, and, most importantly, beneficial for everyone interested in GraphQL and Application security.

This project consists of two main components:

- [`app`](./packages/app/): A Svelte-based IDE that operates directly in your web browser.
- [`lessons`](./packages/lessons/): This directory houses all the tutorial content.

### What is a Lesson?
### What is a "Lesson"?

A lesson in GraphQL Security Academy is structured as a regular `npm` package, containing at least a `package.json` file and a `README.md` file. The README is Svelte-enhanced markdown that drives the lesson content.
A lesson in API Security Academy is structured as a regular `npm` package, containing at least a `package.json` file and a `README.md` file. The README is Svelte-enhanced markdown that drives the lesson content.

### Quick Start Guide

Expand All @@ -45,9 +45,9 @@ yarn install
yarn dev
```

Now, you should have a local instance of GraphQL Security Academy running. Feel free to make changes and test them out.
Now, you should have a local instance of API Security Academy running. Feel free to make any changes and test them out.

### Contribution Ideas
### Contribution ideas

- Writing new lessons or updating existing ones.
- Enhancing the UI/UX of the `app` component.
Expand All @@ -56,3 +56,5 @@ Now, you should have a local instance of GraphQL Security Academy running. Feel
Feel free to submit a pull request or create an issue to discuss any changes you have in mind.

Thank you for contributing to making GraphQL more secure!

> And hurry up to start your first lesson [here](https://escape.tech/academy/broken-authentication?utm_source=github&utm_medium=social)!

0 comments on commit 0c85545

Please sign in to comment.