Funded under the Information and Communication Technologies programme of Horizon 2020’s Industrial Leadership component, and its call for collective awareness platforms for sustainability and social innovation, the Families_Share project is developing a social networking and awareness-raising platform dedicated to encouraging childcare and work/life balance. The platform capitalises on neighbourhood networks and enables citizens to come together to share tasks, time and skills relevant to childcare and after-school education/leisure, where these have become unaffordable in times of stagnation and austerity.
-
If the user doesn’t have Node.js locally installed on their machine they can get and install the latest version from: NodeJS
-
In addition, the user needs to have a Google account. Any Gmail account is a valid developer account. If they don’t have one, they can create one at: Google Account
-
The user needs to create a new Google project and a service account, as they will need the key from the service account in order to access the Google APIs from their Node.js client. Subsequently they need to enable the Google Calendar API that is necessary for the calendar features of the platform. All the above functionalities can be accessed from Google’s developer console. The following links can act as a guide for the above actions: Google Project, Google Service Account , Google APIs
-
In case the user wants to enable single sign on with Google, which is supported by the platform they will need to create an OAuth client ID from their Google developer console credential’s section. During the creation of the OAuth client ID the user needs to select “Web application” as the type and authorize redirects to http://localhost:4000 and their production server URL in order to use this functionality both in development and production.
-
An additional email account is needed, that will act as the platform’s email account which notifies the users for platform specific events.
-
In case the user wants to enable front-end error logs in production they will need a SENTRY account and a Sentry React project. These canbe created at: Sentry
-
Finally,in case the user wants to opt in for analytics in your production deployment they will need a Google Analytics account. You can create one at : Google Analytics
- At first the user needs a clone of the Families Share repository. They may acquire one from: Code
- Alternatively, if the user has Git locally installed on their machine, they can run the following command in their terminal:
git clone https://github.com/vilabs/Families_Share-platform- After that the user has to install package dependencies both for client and server application by running the following command in the respective folders:
npm install- An .env file needs to be created both for the server and client folder (based on the corresponding .env.sample files).
- In order to run the application in development mode the user needs to run the following command in the projects main folder.
npm run dev- In order for the application to run in production mode the user needs to execute the following commands in the client and main folder correspondingly:
npm run build
npm start