Skip to content

📚 A Social Networking app based on users book interest 📚

Notifications You must be signed in to change notification settings

mirsahib/BookAlly-Mobile

Repository files navigation

Book-Ally


A Social Networking app based on users book interest

screenshots of example app

Requirement


  1. Node (10.19.0)
  2. NPM (6.14.6) or Yarn (1.22.5)

Installation


npm i -g create-react-native-app // this command may need super user access
git clone https://github.com/mirsahib/BookAlly-Mobile.git
cd book-ally-mobile

# Install npm dependencies
npm install;

Features


  • Create user account
  • Upload user book information
  • Get friend suggestion based on the users book interest
  • Get connect with new friends who have similar book interest
  • Messaging platform

Api

https://github.com/ASIF-Mahmud1/book-web

Folder Structure


app

Contains application source code

app/ ** test **

Contains generic test files. We should write test for components, services etc. inside of related folder.

app/components

Contains stateless, lean components. We can use anywhere without big updates. When writing code we do not forget KISS.

app/config

Contains static datas of app. With this folder, we can manage all static fields by one location.

app/containers

Contains screen of app. You can create sub container components in related container.

app/containers/{containerName}.js

It is presentational segment of component.It must be stateless.Do not write business logic and do not bind redux.

app/containers/{containerName}Container.js

It is business and flow segment of component. It must contain only related presentational component.

app/helper

Contains util and helper class. These functions must be simple.

app/images

Contains images.

app/redux/modules

Contains feature based redux elements. Every module must be same name with related container.

app/redux/modules/{ModuleName}.js

It must be contain action types, actions and reducer. We want keep simple every changes. If we split these domains to seperate files, When add a new action, a lot of file affected. We escaping this case.

app/redux/middlewares

Contains first-party middlewares.

app/services

Contains wrappers of services.

Contribution Process


If you want to contribute and make this project much better for other developer have a look at Issues.

Pull Request for contributor

Before making a PR request you must follow the following workflow:

  • fork then clone your remote repository
  • make some changes to your local repository
  • add and commit the changes to your local development branch
  • push the changes to your remote development branch
  • make a pull request from your remote development branch

Pull Request for collaborator

  • Clone the repository (skip this step if you get promoted from contributor to collaborator)
  • make some changes to your local repository
  • add and commit the changes to your local development branch
  • push the changes to your remote development branch
  • make a pull request from your remote development branch

DO not push code to master branch, I repeat do not push code to master branch.

Special Thanks


Asim Olmez for react-folder-structure

Reference


https://stackoverflow.com/questions/60647270/best-practice-to-make-project-structure-react-native

About

📚 A Social Networking app based on users book interest 📚

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published