Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jayair authored Aug 29, 2023
1 parent 70cb023 commit 1b87f3b
Showing 1 changed file with 19 additions and 25 deletions.
44 changes: 19 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,55 @@
<p align="center">
<a href="https://sst.dev/">
<img alt="SST" src="https://raw.githubusercontent.com/sst/identity/main/variants/sst-full.svg" width="377" />
<img alt="SST" src="https://raw.githubusercontent.com/sst/identity/main/variants/sst-full.svg" width="300" />
</a>
</p>

<p align="center">
<a href="https://discourse.sst.dev"><img alt="Discourse posts" src="https://img.shields.io/discourse/https/discourse.sst.dev/posts.svg?style=for-the-badge" /></a>
<a href="https://twitter.com/SST_dev"><img alt="Twitter follow" src="https://img.shields.io/twitter/follow/SST_dev.svg?label=twitter&style=for-the-badge" /></a>
<a href="https://sst.dev/discord"><img alt="Chat on Discord" src="https://img.shields.io/discord/983865673656705025?style=for-the-badge" /></a>
<a href="https://sst.dev/discord"><img alt="Discord" src="https://img.shields.io/discord/983865673656705025?style=flat-square&label=Discord" /></a>
<a href="https://twitter.com/sst_dev"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-26a7de?style=flat-square" /></a>
<a href="https://www.youtube.com/c/sst-dev"><img alt="YouTube" src="https://img.shields.io/youtube/channel/subscribers/UCho8kA4-HMolEq6qEMRJetg?style=flat-square&label=YouTube" /></a>
</p>

---

The [SST Guide](https://sst.dev/guide.html) is a comprehensive open source tutorial for building and deploying full-stack apps using Serverless and React on AWS.
Repo for [**SST.dev**](https://sst.dev) and the [SST Guide](https://sst.dev/guide.html). If you are looking for the SST repo, [head over here](https://github.com/sst/sst).

## SST Guide

The guide is a comprehensive open source tutorial for building and deploying full-stack apps using Serverless and React on AWS.

We are going to create a [note taking app](https://demo.sst.dev) from scratch using React.js, AWS Lambda, API Gateway, DynamoDB, and Cognito.

![Demo App](assets/completed-app-desktop.png)

It is a single-page React app powered by a serverless CRUD API. We also cover how add user authentication and handle file uploads.

The entire guide is hosted on GitHub and we use [Discourse][discourse] for our comments. With the help of the community we add more detail to the guide and keep it up to date.

## Project Goals
### Project Goals

- Provide a free comprehensive resource
- Add more content to build on core concepts
- Keep the content accurate and up to date
- Help people resolve their issues

## Getting Help
### Getting Help

- If you are running into issues with a specific chapter, post in the comments for that [chapter][discourse].
- If you are running into issues with a specific chapter, join us on [Discord][discord] and post in `#help`.
- Open a [new issue](../../issues/new) if you've found a bug
- Or if you have a suggestion create a [new topic][discourse] in our forums
- If you've found a typo, edit the chapter and submit a [pull request][pr].

## Source for the Demo App
#### Source for the Demo App

- [Demo Notes App](https://github.com/sst/demo-notes-app)

We also have an alternative Serverless Framework version: [backend serverless API](https://github.com/AnomalyInnovations/serverless-stack-demo-api) & [frontend React app](https://github.com/AnomalyInnovations/serverless-stack-demo-client).

## Contributing

Thank you for your considering to contribute. [Read more about how you can contribute to SST][contributing].

## Running Locally
### Running Locally

SST is built using [Jekyll](https://jekyllrb.com). [Follow these steps to install Jekyll](https://jekyllrb.com/docs/installation/).

#### Viewing Locally
### Viewing Locally

To install, run the following in the root of the project.

Expand All @@ -77,7 +76,7 @@ $ bundle exec jekyll serve --incremental --livereload
We use [Pandoc](https://pandoc.org) to create the eBook. You can generate it locally by following these steps.

```bash
$ cd ~/Sites/ServerlessStackCom/etc/ebook
$ cd ~/Sites/sst.dev/etc/ebook
$ make start
```

Expand All @@ -88,17 +87,11 @@ $ make pdf
$ make epub
```

The above are run automatically through [Github Actions](https://github.com/AnomalyInnovations/serverless-stack-com/actions) in this repo:
The above are run automatically through [Github Actions](https://github.com/sst/sst.dev/actions) in this repo:

- When a new commit is pushed to master
- And when a new tag is pushed, the generated eBook is uploaded to S3

<!--
## Sponsors
[**Sponsor SST on GitHub**](https://github.com/sponsors/jayair) if you've found this guide useful or would like to be an official supporter. [A big thanks to our supporters](https://sst.dev/sponsors.html)!
-->

## Contributors

Thanks to these folks for their contributions to the content of SST.
Expand All @@ -117,8 +110,9 @@ Thanks to these folks for their contributions to the content of SST.

---

This repo is maintained by [SST](https://sst.dev).
**Join our community** [Discord][discord] | [YouTube](https://www.youtube.com/c/sst-dev) | [Twitter](https://twitter.com/SST_dev) | [Contribute][contributing]

[discourse]: https://discourse.sst.dev
[discord]: https://sst.dev/discord
[contributing]: CONTRIBUTING.md
[pr]: ../../compare

0 comments on commit 1b87f3b

Please sign in to comment.