mirror of
https://github.com/Ocelot-Social-Community/Ocelot-Social.git
synced 2025-12-12 23:35:58 +00:00
Merge more READMEs
This commit is contained in:
Robert Schäfer
parent
5c9e430a24
commit
627487629b
19
README.md
19
README.md
@ -1,6 +1,8 @@
|
||||
# Human-Connection
|
||||
|
||||
[](https://human-connection.org)
|
||||
[](https://travis-ci.com/Human-Connection/Human-Connection)
|
||||
[](https://github.com/Human-Connection/Nitro-Backend/blob/backend/LICENSE.md)
|
||||
[](https://discord.gg/6ub73U3)
|
||||
|
||||
Human Connection is a nonprofit social, action and knowledge network that connects information to action and promotes positive local and global change in all areas of life.
|
||||
|
||||
@ -8,6 +10,7 @@ Human Connection is a nonprofit social, action and knowledge network that connec
|
||||
* **Knowledge**: Read articles about interesting topics and find related posts in the **More Info** tab or by **Filtering** based on **Categories** and **Tagging** or by using the **Fulltext Search**.
|
||||
* **Action**: Don't just read about how to make the world a better place, but come into **Action** by following provided suggestions on the **Action** tab provided by other people or **Organisations**.
|
||||
|
||||
[](https://human-connection.org)
|
||||
|
||||
**Technology Stack**
|
||||
|
||||
@ -19,7 +22,6 @@ Human Connection is a nonprofit social, action and knowledge network that connec
|
||||
|
||||
|
||||
## Live demo
|
||||
[](https://travis-ci.com/Human-Connection/Human-Connection)
|
||||
|
||||
Try out our deployed [staging environment](https://nitro-staging.human-connection.org/).
|
||||
|
||||
@ -37,9 +39,18 @@ Learn how to set up a local development environment in our [Docs](https://docs.h
|
||||
|
||||
## Translations
|
||||
|
||||
Contribute translations on [lokalise.co](https://lokalise.co/public/556252725c18dd752dd546.13222042/).
|
||||
You can help translating the interface by joining us on [lokalise.co](https://lokalise.co/public/556252725c18dd752dd546.13222042/).
|
||||
Thank you [lokalise.co](https://lokalise.co/) for providing us with a premium account.
|
||||
|
||||
## Developer Chat
|
||||
|
||||
Join the open-source community on [Discord](https://discord.gg/6ub73U3).
|
||||
Join the friendly open-source community on [Discord](https://discord.gg/6ub73U3).
|
||||
Quickly introduce yourself at `#user-presentation` and ask `@@Mentor` for help :simple_smile:.
|
||||
|
||||
|
||||
## Attributions
|
||||
|
||||
Locale Icons made by [Freepik](http://www.freepik.com/) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)
|
||||
|
||||
## License
|
||||
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).
|
||||
|
||||
@ -1,43 +1,14 @@
|
||||
# NITRO Backend
|
||||
# Backend
|
||||
|
||||
[](https://travis-ci.com/Human-Connection/Nitro-Backend) [](https://github.com/Human-Connection/Nitro-Backend/blob/backend/LICENSE.md) [](https://app.fossa.io/projects/git%2Bgithub.com%2FHuman-Connection%2FNitro-Backend?ref=badge_shield) [](https://discord.gg/6ub73U3)
|
||||
|
||||
> This Prototype tries to resolve the biggest hurdle of connecting our services together. This is not possible in a sane way using our current approach.
|
||||
>
|
||||
> With this Prototype we can explore using the combination of GraphQL and the Neo4j Graph Database for achieving the connected nature of a social graph with better development experience as we do not need to connect data by our own any more through weird table structures etc.
|
||||
## Installation with Docker
|
||||
|
||||
>
|
||||
|
||||
> **Advantages:**
|
||||
>
|
||||
> * easer data structure
|
||||
> * better connected data
|
||||
> * easy to achieve "recommendations" based on actions \(relations\)
|
||||
> * more performant and better to understand API
|
||||
> * better API client that uses caching
|
||||
>
|
||||
> We still need to evaluate the drawbacks and estimate the development cost of such an approach
|
||||
|
||||
### How to get in touch
|
||||
|
||||
Connect with other developers over [Discord](https://discord.gg/6ub73U3)
|
||||
|
||||
### Quick Start
|
||||
|
||||
#### Requirements
|
||||
|
||||
Node >= `v10.12.0`
|
||||
Make sure you are on a [node](https://nodejs.org/en/) version >= `v10.12.0`:
|
||||
|
||||
```text
|
||||
node --version
|
||||
```
|
||||
|
||||
#### Forking the repository
|
||||
|
||||
Before you start, fork the repository using the fork button above, then clone it to your local machine using `git clone https://github.com/your-username/Nitro-Backend.git`
|
||||
|
||||
#### Installation with Docker
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
@ -59,7 +30,7 @@ To wipe out your neo4j database run:
|
||||
docker-compose down -v
|
||||
```
|
||||
|
||||
#### Installation without Docker
|
||||
## Installation without Docker
|
||||
|
||||
Install dependencies:
|
||||
|
||||
@ -109,7 +80,7 @@ This will start the GraphQL service \(by default on localhost:4000\) where you c
|
||||
|
||||
|
||||
|
||||
### Configure
|
||||
## Configure
|
||||
|
||||
Set your Neo4j connection string and credentials in `.env`. For example:
|
||||
|
||||
@ -125,13 +96,7 @@ NEO4J_PASSWORD=letmein
|
||||
|
||||
Note that grand-stack-starter does not currently bundle a distribution of Neo4j. You can download [Neo4j Desktop](https://neo4j.com/download/) and run locally for development, spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download/), run Neo4j in one of the [many cloud options](https://neo4j.com/developer/guide-cloud-deployment/), [spin up Neo4j in a Docker container](https://neo4j.com/developer/docker/) or on Debian-based systems install [Neo4j from the Debian Repository](http://debian.neo4j.org/). Just be sure to update the Neo4j connection string and credentials accordingly in `.env`.
|
||||
|
||||
### Mock API Results
|
||||
|
||||
Alternatively you can just mock all responses from the api which let you build a frontend application without running a neo4j instance.
|
||||
|
||||
Just set `MOCK=true` inside `.env` or pass it on application start.
|
||||
|
||||
### Seed and Reset the Database
|
||||
# Seed and Reset the Database
|
||||
|
||||
Optionally you can seed the GraphQL service by executing mutations that will write sample data to the database:
|
||||
|
||||
@ -149,7 +114,7 @@ yarn db:reset
|
||||
npm run db:reset
|
||||
```
|
||||
|
||||
### Run Tests
|
||||
# Testing
|
||||
|
||||
**Beware**: We have no multiple database setup at the moment. We clean the database after each test, running the tests will wipe out all your data!
|
||||
|
||||
@ -170,19 +135,3 @@ npm run test:cucumber
|
||||
```
|
||||
|
||||
When some tests fail, try `yarn db:reset` and after that `yarn db:seed`. Then run the tests again
|
||||
|
||||
### Todo\`s
|
||||
|
||||
* [x] add jwt authentication
|
||||
* [ ] get directives working correctly \(@toLower, @auth, @role, etc.\)
|
||||
* [x] check if search is working
|
||||
* [x] check if sorting is working
|
||||
* [x] check if pagination is working
|
||||
* [ ] check if upload is working \(using graphql-yoga?\)
|
||||
* [x] evaluate middleware
|
||||
* [ ] ignore Posts and Comments by blacklisted Users
|
||||
|
||||
### License
|
||||
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2FHuman-Connection%2FNitro-Backend?ref=badge_large)
|
||||
|
||||
|
||||
@ -1,12 +1,8 @@
|
||||
# NITRO Web-App
|
||||
|
||||
[](https://travis-ci.com/Human-Connection/Nitro-Web) [](https://github.com/Human-Connection/Nitro-Web/blob/master/LICENSE.md) [](https://app.fossa.io/projects/git%2Bgithub.com%2FHuman-Connection%2FNitro-Web?ref=badge_shield) [](https://discord.gg/6ub73U3)
|
||||
# Webapp
|
||||
|
||||
|
||||
|
||||
### Build Setup
|
||||
|
||||
#### Install
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# install all dependencies
|
||||
@ -22,14 +18,14 @@ cp cypress.env.template.json cypress.env.json
|
||||
|
||||
Configure the files according to your needs and your local setup.
|
||||
|
||||
#### Development
|
||||
### Build for Development
|
||||
|
||||
```bash
|
||||
# serve with hot reload at localhost:3000
|
||||
$ yarn dev
|
||||
```
|
||||
|
||||
#### Build for production
|
||||
### Build for Production
|
||||
|
||||
```bash
|
||||
# build for production and launch server
|
||||
@ -37,7 +33,7 @@ $ yarn build
|
||||
$ yarn start
|
||||
```
|
||||
|
||||
### Styleguide
|
||||
## Styleguide
|
||||
|
||||
All reusable Components \(for example avatar\) should be done inside the [Nitro-Styleguide](https://github.com/Human-Connection/Nitro-Styleguide) repository.
|
||||
|
||||
@ -46,18 +42,3 @@ All reusable Components \(for example avatar\) should be done inside the [Nitro-
|
||||
More information can be found here: [https://github.com/Human-Connection/Nitro-Styleguide](https://github.com/Human-Connection/Nitro-Styleguide)
|
||||
|
||||
If you need to change something in the styleguide and want to see the effects on the frontend immediately, then we have you covered. You need to clone the styleguide to the parent directory `../Nitro-Styleguide` and run `yarn && yarn run dev`. After that you run `yarn run dev:styleguide` instead of `yarn run dev` and you will see your changes reflected inside the fronten!
|
||||
|
||||
### Internationalization \(i18n\)
|
||||
|
||||
You can help translating the interface by joining us on [lokalise.co](https://lokalise.co/public/556252725c18dd752dd546.13222042/).
|
||||
|
||||
Thanks lokalise.co that we can use your premium account!
|
||||
|
||||
### Attributions
|
||||
|
||||
Locale Icons made by [Freepik](http://www.freepik.com/) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)
|
||||
|
||||
### License
|
||||
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2FHuman-Connection%2FNitro-Web?ref=badge_large)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user