Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Illu committed Feb 5, 2021
1 parent 0acbd28 commit a88a5fa
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 4 deletions.
62 changes: 60 additions & 2 deletions README.md
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)

![Build iOS](https://github.com/Illu/Pix/workflows/Build%20iOS/badge.svg?branch=main)
[![iTunes App Store](https://img.shields.io/itunes/v/1542611830.svg?style=flat-square)](https://apps.apple.com/app/pix-share-your-art/id1542611830?l=en)
![license: MIT](https://img.shields.io/github/license/illu/pix?style=flat-square)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![Build iOS](https://github.com/Illu/Pix/workflows/Build%20iOS/badge.svg?branch=main)

<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)
4 changes: 2 additions & 2 deletions ios/pix.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@
CODE_SIGN_ENTITLEMENTS = pix/pix.entitlements;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 8;
CURRENT_PROJECT_VERSION = 9;
DEVELOPMENT_TEAM = 6WD2C784QG;
ENABLE_BITCODE = NO;
INFOPLIST_FILE = pix/Info.plist;
Expand Down Expand Up @@ -710,7 +710,7 @@
CODE_SIGN_ENTITLEMENTS = pix/pix.entitlements;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 8;
CURRENT_PROJECT_VERSION = 9;
DEVELOPMENT_TEAM = 6WD2C784QG;
INFOPLIST_FILE = pix/Info.plist;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
Expand Down

0 comments on commit a88a5fa

Please sign in to comment.