Skip to content

Commit 95638f8

Browse files
authored
Root readme (#9)
* docs: root readme * docs: remove screenshot * docs: move assets to .github/ * Move in examples repositories (#13) * docs: move in example repositories * docs: update link to react-native example
1 parent 48c4339 commit 95638f8

File tree

162 files changed

+51177
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+51177
-1
lines changed

.github/assets/logo-dark.svg

+14
Loading

.github/assets/logo-light.svg

+14
Loading

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<p align="center">
2+
<a href="https://magicbell.com">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="./.github/assets/logo-light.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="./.github/assets/logo-dark.svg">
6+
<img alt="MagicBell" src="./.github/assets/logo-dark.svg" width="300" height="60" style="max-width: 100%;">
7+
</picture>
8+
</a>
9+
</p>
10+
11+
<p align="center">
12+
Modern Notification System with API & UI components for multi-channel delivery - in-app, email, push, Slack & more!
13+
</p>
14+
15+
---
16+
17+
## SDKs
18+
19+
Apart from our [REST](https://www.magicbell.com/docs/rest-api/overview) and [GraphQL](https://www.magicbell.com/docs/graphql-api/overview) API, we offer API wrappers in several programming languages:
20+
21+
- [JavaScript/TypeScript](https://github.com/magicbell-io/magicbell-js)
22+
- [Ruby](https://github.com/magicbell-io/magicbell-ruby)
23+
- [iOS](https://github.com/magicbell-io/magicbell-swift)
24+
- [Android](https://github.com/magicbell-io/magicbell-android)
25+
26+
## Documentation
27+
28+
Read the full documentation and guides on [magicbell.com](https://magicbell.com/).
29+
30+
Contribute in [/docs](./docs).
31+
32+
## Examples
33+
34+
Check out the example repositories that show how to use MagicBell in [/examples](./examples).
35+
36+
## Community
37+
38+
Discuss MagicBell on [GitHub Discussions](https://github.com/magicbell-io/public/discussions).
39+
40+
## OpenAPI specifications
41+
42+
Check the OpenAPI specifications for the MagicBell REST API in [/openapi](./openapi).

docs/docs/react-native/implement-mobile-push-notifications.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ PushNotification.configure({
4343
```
4444

4545
If you face any issues while configuring the library, please feel free to shoot us a note, we will be happy to help.
46-
You might also find it helpful to read the [full React Native example](https://github.com/magicbell-io/react-native-notifications-example) we created.
46+
You might also find it helpful to read the [full React Native example](https://github.com/magicbell-io/public/examples/react-native-notifications-example) we created.
4747

4848
This is a sample payload MagicBell will push to your app:
4949

examples/gatsby-example/.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
.cache/
3+
public

examples/gatsby-example/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# MagicBell Gatsby example
2+
3+
This repo shows how to use the `@magicbell/react-headless` package to render notifications in a Gatsby application.
4+
5+
## Quick start
6+
7+
Navigate into the site’s directory and start it up.
8+
9+
```shell
10+
cd magicbell-gatsby-example/
11+
npm run develop
12+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import * as React from "react";
2+
import Layout from "./src/components/Layout";
3+
import "./src/styles/global.css";
4+
5+
export const wrapPageElement = ({ element, props }) => (
6+
<Layout {...props}>{element}</Layout>
7+
);
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
siteMetadata: {
3+
title: `MagicBell Gatsby Example`,
4+
siteUrl: `https://www.yourdomain.tld`,
5+
},
6+
plugins: ["gatsby-plugin-postcss"],
7+
};
+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import * as React from "react";
2+
import Layout from "./src/components/Layout";
3+
4+
export const onRenderBody = ({ setBodyAttributes }, pluginOptions) => {
5+
setBodyAttributes({
6+
className: "h-full",
7+
});
8+
};
9+
10+
export const wrapPageElement = ({ element, props }) => (
11+
<Layout {...props}>{element}</Layout>
12+
);

0 commit comments

Comments
 (0)