diff --git a/.env.local b/.env.local index 8ca3788..9e76e81 100644 --- a/.env.local +++ b/.env.local @@ -1,3 +1,4 @@ CI=false # Needed to skip warnings from jest@beta in package.json SKIP_PREFLIGHT_CHECK=true + diff --git a/.eslintrc.js b/.eslintrc.js index 7396b65..f5adc80 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -66,5 +66,8 @@ module.exports = { 'import/no-dynamic-require': 0 } } - ] + ], + globals: { + "fetch": false + } } diff --git a/.gitignore b/.gitignore index 29ffa31..ea39237 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,8 @@ **/*.log .DS_Store **/.DS_Store - +.idea +*.iml # Dependencies **/node_modules diff --git a/README.md b/README.md index ea9c4db..ccb06ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# myProject +# GiveMe.lk (alias e-pola) + +GiveMe.lk is a tool for connecting people with essential requirements during the social distancing peroid because the SARS-CoV-2 virus started to spread worldwide. + +There are two main aspects of this tool + +- Let people in isolation request items they need +- Let suppliers who are working to supply essentials see requirement quantity geographically [![Build Status][build-status-image]][build-status-url] [![Code Coverage][coverage-image]][coverage-url] @@ -8,12 +15,11 @@ ## Table of Contents -1. [Features](#features) 1. [Requirements](#requirements) 1. [Getting Started](#getting-started) 1. [Application Structure](#application-structure) 1. [Development](#development) - 1. [Routing](#routing) + 1. [Routing](#routing) 1. [Testing](#testing) 1. [Configuration](#configuration) 1. [Production](#production) @@ -21,65 +27,52 @@ ## Requirements -* node `^10.15.0` -* npm `^6.0.0` +- node `^10.15.0` +- npm `^6.0.0` ## Getting Started -1. Install app and functions dependencies: `npm i && npm i --prefix functions` +1. Install app and functions dependencies: `yarn` 1. Create `src/config.js` file that looks like so if it does not already exist: - ```js - const firebase = { - // Config from Firebase console - } - - // Overrides for for react-redux-firebase/redux-firestore config - export const reduxFirebase = {} - - export const segmentId = '<- Segment ID ->' - - export const publicVapidKey = '<- publicVapidKey from Firebase console ->' - - export const sentryDsn = '<- DSN From Sentry.io ->' - - export default { - env, - firebase, - reduxFirebase, - sentryDsn, - publicVapidKey, - segmentId - } - ``` -1. Start Development server: `npm start` - -While developing, you will probably rely mostly on `npm start`; however, there are additional scripts at your disposal: - -|`npm run -