Skip to content

TheSoftwareHouse/github-favourites

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting started

Installation:

Install dependencies using yarn package manager

yarn

Environment variables

REACT_APP_GITHUB_API_URL=https://api.github.com/
REACT_APP_GITHUB_ACCESS_TOKEN=SECRET_TOKEN 

Create .env.development.local and .env.production.local files, one for development and second for production build.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles Application in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Project Structure

api

REST API Client definition, in subfolder actions you can add new API action definition.

app

Place for pages of application, structured in directories based on application Domain/Routing.

assets

Directory where all assets ie. images, icons are placed.

components

Place for all components, structured with Atomic Design system. Atoms - smallest possible components, such as buttons, titles, inputs, Molecules - they are the composition of one or more components of atoms. Here we begin to compose complex components and reuse some of those components. Containers - reusable Higher Order Components

dictionaries

Place for dictionaries, ie. list of available languages in select field on homepage.

test

Test utils and mocks, ie. ThemeProvider mock

theme

Default Theme definition and variables, ie. colors, font sizes, default margins etc.

other

Tests are placed in the same directory as tested functionality.

TBD

  • Showing messages during error on API response.
  • Add collapse animation to favourite box and search boxl

About

Test application showing our skills in React and RWD projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors