https://github.com/elixir-cloud-aai/elixir-cloud-aai.github.io-backend
https://github.com/elixir-cloud-aai/elixir-cloud-aai.github.io-backend
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elixir-cloud-aai/elixir-cloud-aai.github.io-backend
- Owner: elixir-cloud-aai
- License: apache-2.0
- Created: 2021-12-31T12:28:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-29T20:03:27.000Z (over 3 years ago)
- Last Synced: 2023-03-06T04:02:25.986Z (about 3 years ago)
- Language: JavaScript
- Homepage: elixir-cloud-aai-github-io-backend.vercel.app
- Size: 145 KB
- Stars: 0
- Watchers: 12
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elixir Cloud & AII Landing page backend
## Introduction
Official backend for webpage of the ELIXIR Cloud & AAI project.
ELIXIR Cloud & AAI develops services towards establishing a federated [cloud
computing](https://en.wikipedia.org/wiki/Cloud_computing) network that enables
the analysis of population-scale genomic and phenotypic data across
participating, international nodes.
## About
This website is built using the [Express.js](https://expressjs.com/) framework for
[Node.js](https://nodejs.org/en/). This will build the api server for the elixir cloud landing page.
Content for the website is fetched from
[Notion](https://developers.notion.com/) & [Twitter API](https://developer.twitter.com/en/docs/twitter-api), where it can be conveniently edited
by authorized users. If you are a member of ELIXIR Cloud & AAI and would like
to contribute, please contact the [administrator](https://github.com/uniqueg).
## Setup
#### Local Environment
Any contributor is welcome to contribute to the website.
To set up the development environment, follow the steps:
- Fork & clone this repository on your local machine.
- Install the required dependencies:
```bash
npm install
```
- Create the [Notion](https://www.notion.so/) account.
- Open the [Elixir Cloud & AAI](https://www.notion.so/Elixir-Cloud-AAI-cdb71fe2334c4e83b920219b2c3b9794) notion page & duplicate it to your account.
- Create the [Notion developers](https://developers.notion.com/) account with the same email. [Create a new integration](https://developers.notion.com/docs#step-1-create-an-integration) in your account & store the Internal Integration Token. [Link the integration](https://developers.notion.com/docs#step-2-share-a-database-with-your-integration) to the duplicated page in your account.
- Create a new file in the root directory with the name `.env` & add your Internal Integration Token as Notion Token:
```bash
NOTION_TOKEN=
```
- Go to [Twitter API](https://developer.twitter.com/en/docs/twitter-api) & get your own API key & add your API key in the `.env` file as:
```bash
TWITTER_TOKEN=
```
- Add the following also to the `.env` file:
```bash
PORT=5000
```
- Start the local development server by:
```bash
npm run dev
```
#### Production Environment
- Create the [Notion](https://www.notion.so/) account & create the [Notion developers](https://developers.notion.com/) account with the same email. [Create a new integration](https://developers.notion.com/docs#step-1-create-an-integration) in your account & store the Internal Integration Token. [Link the integration](https://developers.notion.com/docs#step-2-share-a-database-with-your-integration) to the duplicated page in your account.
- Go to [Twitter API](https://developer.twitter.com/en/docs/twitter-api) & get your own API key.
- In the production env specify the following `env variables`:
```bash
PORT=8080
NOTION_TOKEN=
TWITTER_TOKEN=
```
- Deploy
## Versioning
The project adopts the semantic versioning scheme for versioning. Currently the
site is in beta stage, so content will change frequently.
## License
This project is available under the MIT License also [shipped with this
repository](LICENSE).
## Contact
The project is a collaborative effort under the umbrella of [ELIXIR Cloud &
AAI](https://github.com/elixir-cloud-aai/). Follow the link to get in touch
with us via chat or email. Please mention the name of this service for any
inquiry, proposal, question etc. Alternatively, you can also make use of the
[issue
tracker](https://github.com/elixir-cloud-aai/elixir-cloud-aai.github.io-backend/issues)
to request features or report bugs.