Skip to content
Snippets Groups Projects
Commit e4602513 authored by moon's avatar moon
Browse files

README files updated

parent 8a857d30
No related branches found
No related tags found
No related merge requests found
* Project Code : `DD-Code`
* Lab : Toth-Petroczy
* Contact Persons : Soumyadeep Ghosh (mailto: sghosh@mpi-cbg.de)
* Code Repository : https://git.mpi-cbg.de/scicomp/scidev_team/dd-code/
* Start Date: November 2020
* Data location : `https://git.mpi-cbg.de/scicomp/scidev_team/dd-code/`
# CD-Code Web front-end
# Project Outline
## Modules in CD-Code Web front-end
1. ```web/```: [Vue.js (v2.0)](https://v2.vuejs.org/) based web front-end
2. ```cms/```: [Strapi](https://strapi.io/) based CMS module
To develop a fron-end web application for condensate databases with MongoDB and Elastic search functionalities. The back-end data design and contracts are implemented by Soumyadeep. Scicomp is in charge of the front end web application.
```web``` module provides the user interface for condensate and protein databases stored in MongoDB through [the server API](dd-code-team/dd-code-api), which are carefully curated by contributors.
- the first page will show the table with searched term.
- the second page includes the detailed information of condensate and proteins.
```cms``` module contains all the necessary dependencies to collect all the contributions and coordinate the database curation based on roles (public, contributor, maintainer, administrator).
## References
- https://git.mpi-cbg.de/atplab/dd-code-docs
- http://bio-comp.org.cn/llpsdb/home.aspx
- https://phasepro.elte.hu
- https://www.uniprot.org/
- https://www.mdpi.com/1422-0067/21/18/6796/htm
## README.md in the modules
1. ```web/```: Follow the instructions in [web/README.md](web/README.md)
2. ```cms/```: Read [cms/README.md](cms/README.md)
### Considerations for development and production phases
There are *develop* and *master* branches in the repository in order to reduce the impact on the production service which is running under [https://cd-code.org](https://cd-code.org). After checking the *develop* instance thoroughly, the production version is released with merging *develop* branch into *master*.
\ No newline at end of file
# Strapi application
# CD-Code CMS application
A quick description of your strapi application
### Setup Database
- Install PostgreSQL
- Create ```.env``` file
- Add the below environment variables:
```
DATABASE_USERNAME={id}
DATABASE_PASSWORD={password}
```
### Install and run Strapi
- Install dependencies for Strapi with ```npm install```
- Build with running ```npm run build```
- Run Strapi in development mode with ```npm run develop``` for designing models
- Check all the ```collections``` and ```roles``` in the cms instance
- Run Strapi with ```npm run start``` for the production use
### Directory Structure
```
|-- config # All the config data are overriden by .env file
|-- database # Strapi database customization folder
|-- public # Root folder for the web service
|-- src # Source files
|-- admin # Admin releated folder
|-- api # Contollers for the database schemes
|-- extensions # Extensions for the basic database models
|-- .env # Env varibales to setup for database
|-- README.md # This file
```
# DD-CODE web interface
# CD-CODE web interface
[[_TOC_]]
## Project setup
```
yarn install
```
CD-CODE web interface contains all the front-end source codes based on [vue.js v2](https://v2.vuejs.org/).
### Compiles and hot-reloads for development
## Directory Structure
```
yarn run serve
|-- dist # Distribution folder used for production
|-- public # Root folder for the web service
|-- src # Source files
|-- assets # Static web resources
|-- components # Reusable user interface components
|-- router # Routing url with specific components/views
|-- store # Storage manager per sessionn
|-- views # View pages
|-- App.vue # Unit test files
|-- index.css # Unit test files
|-- main.js # Unit test files
|-- .env # Env varibales to setup
|-- README.md # This file
|-- vue.config.js # Vue releated config file
```
### Compiles and minifies for production
```
yarn run build
```
### Copy all the files under /dist to the web folder
```
cp -R dist/* [your_webserver_root]
```
## Project installation
### Run your tests
```
yarn run test
```
### Setup and build
- Install dependencies
```
yarn install
```
### Lints and fixes files
```
yarn run lint
```
- Compiles and hot-reloads for development
```
yarn run serve
```
- Compiles and minifies for production
```
yarn run build
```
- Copy all the files under /dist to the web folder
```
cp -R dist/* [your_webserver_root]
```
- Run your tests
```
yarn run test
```
- Lints and fixes files
```
yarn run lint
```
### Customize configuration
* It requires proper settings in ```src/components/js/const.js```.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment