Giter Site home page Giter Site logo

ratanasoth / native-directory Goto Github PK

View Code? Open in Web Editor NEW

This project forked from react-native-community/directory

0.0 2.0 0.0 3.15 MB

A list of react native libraries of various qualities that you can use with expo, and ones you can't.

Home Page: https://www.native.directory

License: MIT License

JavaScript 100.00%

native-directory's Introduction

Native Directory

Native Directory is a website where you can see all of the libraries that are compatible with React Native.

Website: https://www.native.directory/

How do I know I'm at the right place?

  • You made a repository on GitHub and you want the world to know it works with React Native.
  • You want to submit a pull request to improve Native Directory.
  • You want to report a bug or make a suggestion.

I don't like your website, can I hit an API instead and build my own better stuff?

Yeah of course:

https://native.directory?json=true

  • Returns a list of all libraries in JSON format.

https://native.directory?json=true&search=webgl

  • Returns a list of all libraries in JSON format that have the keyword webgl.

https://native.directory?json=true&search=webgl&expo=true

  • Returns a list of all libraries in JSON format that have the keyword webgl and work with expo.

https://native.directory?json=true&search=webgl&expo=true&android=true

  • Returns a list of all libraries in JSON format that have the keyword webgl and work with expo and android.

I don't like how you calculate health scores.

  • Submit a PR with changes to scripts/calculate-score.js.
  • You have all the power! Tell us what you want.

How do I add a library?

  • Add it to react-native-libraries.json.
  • Submit a PR.

Please follow this format and indentation:

{
  "githubUrl": "<THE GITHUB URL>",
  "ios": false,
  "android": false,
  "web": false,
  "expo": false
},
  • ios - works on iOS phones.
  • android - works on Android phones.
  • web - can be used in the browser.
  • expo - can be used without detaching an Expo application.

How do I run my own version locally?

Prerequisites

  • Node 7.9.0+

Commands

With npm
npm install
npm run dev
With yarn
yarn add
yarn dev

You should be able to visit localhost:8000 in your browser.

How do I run npm run create-data with keys?

  • To update site data you need to provide a couple of keys in a file called secrets.json.
  • You must create your own secrets.json in the root directory of the repo.
  • Visit https://github.com/settings/developers to get your keys.
{
  "GITHUB_CLIENT_ID": "YOUR CLIENT ID",
  "GITHUB_CLIENT_SECRET": "YOUR CLIENT SECRET"
}

This command creates site data in ./build/data.json

npm run create-data

How do I deploy my own to production?

  • Site is hosted on Heroku.
  • You can deploy your own with your own heroku account and remote.
heroku login
heroku git:remote -a next-expo
git push heroku master

native-directory's People

Contributors

jimmylee avatar brentvatne avatar lwinkyawmyat avatar prscx avatar deadcoder0904 avatar gertjanreynaert avatar matt-oakes avatar serranoarevalo avatar charlesvinette avatar noitidart avatar giautm avatar gre avatar enieber avatar hectahertz avatar wonday avatar vmurin avatar cierpliwy avatar peggyrayzis avatar designorant avatar minishlink avatar oblador avatar jodybrewster avatar douglasjunior avatar dmfrancisco avatar isnifer avatar krsjoseph avatar codesinghanoop avatar lfkwtz avatar maicki avatar michaelvilleneuve avatar

Watchers

James Cloos avatar Ratana SOTH avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.