Skip to content
Snippets Groups Projects
Commit 88516e4e authored by Grigorios Nterekis's avatar Grigorios Nterekis
Browse files

Updating README.md

parent b039be84
No related branches found
No related tags found
No related merge requests found
Pipeline #176706 passed
###
# Place your Prettier ignore content here
###
# .gitignore content is duplicated here due to https://github.com/prettier/prettier/issues/8506
# Created by .ignore support plugin (hsz.mobi)
### Node template
# Logs
/logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# nyc test coverage
.nyc_output
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# TypeScript v1 declaration files
typings/
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
# parcel-bundler cache (https://parceljs.org/)
.cache
# next.js build output
.next
# nuxt.js build output
.nuxt
# Nuxt generate
dist
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless
# IDE / Editor
.idea
# Service worker
sw.*
# macOS
.DS_Store
# Vim swap files
*.swp
{
"semi": false,
"singleQuote": true
}
......@@ -10,4 +10,7 @@ COPY . .
EXPOSE 8000
CMD ["npm", "run", "dev"]
\ No newline at end of file
RUN npm run build
RUN npm run generate
CMD ["npm", "run", "start"]
\ No newline at end of file
# Team Patras Medicine 2022 Wiki
## About this Template
### Files
## Files
The template structure is as follows:
|__ assets/ -> contains uncompiled Sass files
|__ components/ -> contains Vue.js components
|__ Footer.vue -> a footer that will appear in all the pages
|__ Header.vue -> a header component that will appear in all the pages
|__ Nav.vue -> a navbar that will appear in all the pages
|__ WikiTools.vue -> the wiki tools to help getting started with this template
|__ layouts/ -> contains Nuxt.js layouts
|__ default.vue -> a default layout
|__ pages/ -> contains all views and routes of the website
|__ plugins/ _> contains Nuxt.js plugins
|__ .dockerignore -> tells dockers which files/directories should be excluded from the context
|__ .editorconfig -> a collection of text editor plugins for maintaining consistent coding styles
|__ .gitignore -> tells GitLab which files/directories should not be uploaded to the repository
|__ .gitlab-ci.yml -> an automated flow for building, testing and deploying your website.
|__ docker-compose.yml -> a config file for Docker Compose
|__ Dockerfile -> a file with instructions on how to build the docker image
|__ jsconfig.json -> a Javascript configuration file
|__ LICENSE -> License CC-by-4.0, all wikis are required to have this license - DO NOT MODIFY
|__ nuxt.config.js -> a Nuxt configuration file
|__ package-lock.json -> the exact dependencies tree of the website
|__ package.json -> contains all the dependencies and scripts for the website
|__ README.md -> a file containing the text you are reading right now
|__ tailwind.config.js -> a tailwind configuration file
|__ tsconfig.json -> a Typescript configuration file
### Technologies
## Technologies
* [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)
* [Vue.js](https://vuejs.org/): a Javascript web framework
* [Nuxt.js](https://nuxtjs.org/): a Vue.js framework
* [Sass](https://sass-lang.com/): a CSS extension language
* [Bootstrap](https://getbootstrap.com/): a CSS framework
## Building locally
### Using npm:
## Building locally using npm
``` bash
git clone https://gitlab.igem.org/2022/patras-medicine.git
cd patras-medicine
......@@ -44,10 +35,8 @@ npm install
npm run dev
```
### Using Docker:
## Testing production
``` bash
git clone https://gitlab.igem.org/2022/patras-medicine.git
cd patras-medicine
docker-compose up -d --build
docker-compose down #to stop the running container
```
\ No newline at end of file
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