Giter VIP home page Giter VIP logo

betterreads-fe's Introduction

React Maintainability Test Coverage code style: prettier PRs Welcome

Readrr is a social media platform that allows users to connect with other readers alike, search its database of books, browse recommendations, and manage their own library.

Installation

  1. Once you have cloned the repository, download the dependencies with npm install.
  2. Start the server with npm start.

Environment Variables

In order to get the app running locally and working with the backend, you need to set this environment variable in a .env.local file.

REACT_APP_API_URL=http://localhost:5000

Documentation

Tech Stack

  • React - fast and reusable
  • Redux - global state management
  • styled-components - customizable styling
  • Express - simple and effective
  • PostgreSQL - scalability and data persistence
  • AWS - robust and tailored

See this repo for details on the backend of our project.

See this repo for details on the data science of our project.

APIs

  • OAuth 2.0
  • Google Books API
  • Readrr API

Google Analytics

  • Import the necessary functions from the correct directory.
    import { PageView, Events } from './components/tracking';
  • PageView() - tracks page views
    useEffect(() => {
    	PageView();
    }, []);
  • Events(category, action, label) - tracks user interaction with form submits, links, buttons, etc.
    Event('Book', 'User clicked on book details', 'SEARCH_RESULTS');
  • OutboundLink - tracks external links
    <ReactGA.OutboundLink
    	eventLabel="Clicked read online link"
    	to="Link"
    	target="_blank"
    	rel="noopener noreferrer"
    >
    	Read online
    </ReactGA.OutboundLink>
  • Examples can be seen in Search.js, SearchForm.js, and SearchItems.js.

Naming Conventions

  • Branches - kebab case, all lowercase
  • Variable and function names - camel case, descriptive
  • CSS class names - kebab case, descriptive
  • Database fields - camel case

Prettier

  • Single quotes
  • 4 space tabs
  • Semicolon at the end of every line

Contributing

Contributors

Taylor Lohman Nicole Hollis Jonah Aitchison Michael Levick Miguel Nicolas Aasa Christian

License

Readrr is MIT licensed.

betterreads-fe's People

Contributors

aasachristian avatar berniedurfee avatar marfan avatar mcgowent avatar miugel avatar ryan-hamblin avatar tclohm avatar

Watchers

 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.