-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
62 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,61 @@ | ||
# Pix | ||
# [Pix](https://apps.apple.com/app/pix-share-your-art/id1542611830?l=en) | ||
|
||
 | ||
[](https://apps.apple.com/app/pix-share-your-art/id1542611830?l=en) | ||
 | ||
[](https://github.com/prettier/prettier) | ||
 | ||
|
||
<p align="center"> | ||
<img width="200" src="https://maximenory.com/pix/logo.png" /> | ||
</p> | ||
|
||
Pix is an online pixel art community where everyone can unleash their creativity on a 16x16 canvas, built with [React-Native](https://github.com/facebook/react-native) for iOS devices. | ||
|
||
|
||
## Stack | ||
|
||
[React-Native](https://github.com/facebook/react-native) | ||
|
||
[React-Navigation](https://reactnavigation.org/) | ||
|
||
[MobX](https://mobx.js.org/) | ||
|
||
[TypeScript](https://www.typescriptlang.org/) | ||
|
||
[Styled-Components](https://www.styled-components.com/) | ||
|
||
## Preview | ||
|
||
<p align="center"> | ||
<img src="https://maximenory.com/pix/mockup.png" /> | ||
</p> | ||
|
||
## Installation | ||
|
||
If you want to test the app on a simulator running locally, follow these instructions: | ||
|
||
First, you'll need to create or import a `config.ts` file in the `scr` folder, which should export the `firebaseConfig` object. | ||
|
||
```bash | ||
$ cd pix | ||
|
||
$ yarn | ||
|
||
$ cd ios && pod install && cd .. | ||
|
||
$ yarn build-ios | ||
|
||
$ react-native run-ios | ||
``` | ||
|
||
## Contribute | ||
|
||
If you find a bug, feel free to open an issue or submit a pull request. | ||
|
||
New ideas are always welcome, if you have an idea to change or add a feature, let me know by opening an issue or messaging me on [Twitter](https://twitter.com/MaximeNory). | ||
|
||
## Licence | ||
|
||
MIT License | ||
|
||
See [LICENSE](LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters