|
1 |
| -<p align="center"><a href="https://nitric.io" target="_blank"><img src="https://raw.githubusercontent.com/nitrictech/nitric/main/docs/assets/nitric-logo.svg" height="120"></a></p> |
| 1 | +<p align="center"> |
| 2 | + <a href="https://nitric.io"> |
| 3 | + <img src="https://raw.githubusercontent.com/nitrictech/nitric/main/docs/assets/nitric-logo.svg" width="120" alt="Nitric Logo"/> |
| 4 | + </a> |
| 5 | +</p> |
| 6 | + |
| 7 | +<p align="center"> |
| 8 | + A fast & fun way to build portable cloud-native applications |
| 9 | +</p> |
| 10 | + |
| 11 | +<p align="center"> |
| 12 | + <img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/nitrictech/nitric?sort=semver"> |
| 13 | + <a href="https://twitter.com/nitric_io"> |
| 14 | + <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/nitric_io?label=Follow&style=social"> |
| 15 | + </a> |
| 16 | + <a href="https://nitric.io/chat"><img alt="Discord" src="https://img.shields.io/discord/955259353043173427?label=discord"></a> |
| 17 | +</p> |
2 | 18 |
|
3 | 19 | ## Project Description
|
4 | 20 |
|
5 | 21 | Create a shortened URL that redirects to the full URL and receive notifications when URLs are created.
|
6 | 22 |
|
7 |
| -## About Nitric |
| 23 | +## Usage |
| 24 | + |
| 25 | +### Step 1: Install Nitric |
8 | 26 |
|
9 |
| -This is a [Nitric](https://nitric.io) Golang project, but Nitric is a framework for rapid development of cloud-native and serverless applications in many languages. |
| 27 | +Follow the steps in the [installation guide](https://nitric.io/docs/installation) |
10 | 28 |
|
11 |
| -Using Nitric you define your apps in terms of the resources they need, then write the code for serverless function based APIs, event subscribers and scheduled jobs. |
| 29 | +### Step 2: Run your Nitric project locally |
| 30 | + |
| 31 | +Refer to the README located in the language specific version of this project. |
| 32 | + |
| 33 | +## About Nitric |
| 34 | + |
| 35 | +[Nitric](https://nitric.io) is a framework for rapid development of cloud-native and serverless applications. Define your apps in terms of the resources they need, then write the code for serverless function based APIs, event subscribers and scheduled jobs. |
12 | 36 |
|
13 | 37 | Apps built with Nitric can be deployed to AWS, Azure or Google Cloud all from the same code base so you can focus on your products, not your cloud provider.
|
14 | 38 |
|
15 | 39 | Nitric makes it easy to:
|
16 | 40 |
|
17 |
| -- Create smart [serverless functions and APIs](https://nitric.io/docs/apis) |
18 |
| -- Build reliable distributed apps that use [events](https://nitric.io/docs/messaging/topics) and/or [queues](https://nitric.io/docs/messaging/queues) |
19 |
| -- Securely store, retrieve and rotate [secrets](https://nitric.io/docs/secrets) |
20 |
| -- Read and write files from [buckets](https://nitric.io/docs/storage) |
| 41 | +- Create smart serverless functions and APIs |
| 42 | +- Build reliable distributed apps that use events and/or queues |
| 43 | +- Securely store and retrieve secrets |
| 44 | +- Read and write files from buckets |
| 45 | + |
| 46 | +## Documentation |
21 | 47 |
|
22 |
| -## Learning Nitric |
| 48 | +The full documentation is available at [nitric.io/docs](https://nitric.io/docs). |
23 | 49 |
|
24 |
| -Nitric provides detailed and intuitive [documentation](https://nitric.io/docs) and [guides](https://nitric.io/docs/getting-started) to help you get started quickly. |
| 50 | +We're completely open-source and encourage [code contributions](https://nitric.io/docs/contributions). |
25 | 51 |
|
26 |
| -If you'd rather chat with the maintainers or community, come and join our [Discord](https://nitric.io/chat) server, [GitHub Discussions](https://github.com/nitrictech/nitric/discussions) or find us on [Twitter](https://twitter.com/nitric_io). |
| 52 | +## Get in touch |
27 | 53 |
|
28 |
| -## Running this project |
| 54 | +- Ask questions in [GitHub discussions](https://github.com/nitrictech/nitric/discussions) |
29 | 55 |
|
30 |
| -To run this project you'll need the [Nitric CLI](https://nitric.io/docs/installation) installed, then you can use the CLI commands to run, build or deploy the project. |
| 56 | +- Find us on [Twitter](https://twitter.com/nitric_io) |
31 | 57 |
|
32 |
| -```bash |
33 |
| -# install dependencies |
34 |
| -go mod tidy |
| 58 | +- Send us an [email ](mailto:[email protected]) |
35 | 59 |
|
36 |
| -# run locally |
37 |
| -nitric start |
38 |
| -``` |
| 60 | +- Jump into our [Discord server](https://nitric.io/chat) |
0 commit comments