Timofey Malinin
3 years ago
parent
6a347d7e0b
commit
81145cb689
@ -1,95 +1,97 @@
|
|||||||
# Postamates Frontend
|
# Рекомендательный сервис для размещения постаматов
|
||||||
|
|
||||||
To build the project all you need is `yarn build` command
|
### Инструкция по развёртыванию frontend части проекта:
|
||||||
|
- Установите [docker](https://docs.docker.com/engine/install/ubuntu/)
|
||||||
## Getting started
|
- Установите [docker compose](https://docs.docker.com/compose/install/)
|
||||||
|
- Положите файлы из репозитория в папку ```postamates_frontend```:
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
- через GIT:
|
||||||
|
```bash
|
||||||
Already a pro? Just edit this README.md and make it your own. Want to make it
|
git clone git@gitlab.com:leaders2022/postamates_frontend.git postamates
|
||||||
easy? [Use the template at the bottom](#editing-this-readme)!
|
git pull
|
||||||
|
git checkout sst_main
|
||||||
## Add your files
|
git pull
|
||||||
|
```
|
||||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
- через zip архив:
|
||||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
```unzip archieve.zip -d postamates_frontend```
|
||||||
|
|
||||||
```
|
- создайте файл ```postamates_frontend/.env``` на основе файла ```postamates_frontend/.env.like```
|
||||||
cd existing_repo
|
- Запустите проект:
|
||||||
git remote add origin https://gitlab.com/leaders2022/postamates_frontend.git
|
```
|
||||||
git branch -M main
|
cd postamates
|
||||||
git push -uf origin main
|
sudo docker-compose up -d
|
||||||
```
|
```
|
||||||
|
после этого статика проекта будет находиться в директории ```postamates_frontend/dist```
|
||||||
## Integrate with your tools
|
|
||||||
|
### Инструкция по devops части проекта:
|
||||||
- [ ] [Set up project integrations](https://gitlab.com/leaders2022/postamates_frontend/-/settings/integrations)
|
- Установите [backend](https://gitlab.com/leaders2022/postamates/-/tree/sst_main/)
|
||||||
|
- Установите [frontend](https://gitlab.com/leaders2022/postamates_frontend/-/tree/sst_main/)
|
||||||
## Collaborate with your team
|
|
||||||
|
- Настройте nginx в зависимости от конфигураций .env файлов в backend и frontend репозиториях
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
- Пример конфигурации:
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
```server {
|
||||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
server_name postnet-dev.selftech.ru;
|
||||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
||||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
listen 443 ssl; # managed by Certbot
|
||||||
|
ssl_certificate /etc/letsencrypt/live/postnet-dev.selftech.ru/fullchain.pem; # managed by Certbot
|
||||||
## Test and Deploy
|
ssl_certificate_key /etc/letsencrypt/live/postnet-dev.selftech.ru/privkey.pem; # managed by Certbot
|
||||||
|
include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
|
||||||
Use the built-in continuous integration in GitLab.
|
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
|
||||||
|
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
root /home/postamates_frontend/dist;
|
||||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
||||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
index index.html;
|
||||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
client_max_body_size 400m;
|
||||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
location / {
|
||||||
|
try_files $uri /index.html;
|
||||||
***
|
}
|
||||||
|
|
||||||
# Editing this README
|
|
||||||
|
location /api/ {
|
||||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header Host $http_host;
|
||||||
## Suggestions for a good README
|
proxy_redirect off;
|
||||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
proxy_pass http://0.0.0.0:DJANGO_PORT/api/;
|
||||||
|
}
|
||||||
## Name
|
location /admin/ {
|
||||||
Choose a self-explaining name for your project.
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header Host $http_host;
|
||||||
## Description
|
proxy_redirect off;
|
||||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
proxy_pass http://0.0.0.0:DJANGO_PORT/admin/;
|
||||||
|
}
|
||||||
## Badges
|
location /accounts/ {
|
||||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header Host $http_host;
|
||||||
## Visuals
|
proxy_redirect off;
|
||||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
proxy_pass http://0.0.0.0:DJANGO_PORT/accounts/;
|
||||||
|
}
|
||||||
## Installation
|
location /media {
|
||||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
alias /home/postamates/media;
|
||||||
|
}
|
||||||
## Usage
|
|
||||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
location /django_static {
|
||||||
|
alias /home/postamates/django_static;
|
||||||
## Support
|
}
|
||||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
||||||
|
location /martin {
|
||||||
## Roadmap
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
proxy_set_header Host $http_host;
|
||||||
|
proxy_redirect off;
|
||||||
## Contributing
|
proxy_pass http://0.0.0.0:MARTIN_PORT/;
|
||||||
State if you are open to contributions and what your requirements are for accepting them.
|
}
|
||||||
|
|
||||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
error_page 500 502 503 504 /50x.html;
|
||||||
|
|
||||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
location = /50x.html {
|
||||||
|
root /usr/share/nginx/html;
|
||||||
## Authors and acknowledgment
|
}
|
||||||
Show your appreciation to those who have contributed to the project.
|
}
|
||||||
|
server {
|
||||||
## License
|
server_name postnet-dev.selftech.ru;
|
||||||
For open source projects, say how it is licensed.
|
if ($host = postnet-dev.selftech.ru) {
|
||||||
|
return 301 https://$host$request_uri;
|
||||||
## Project status
|
}
|
||||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
listen 80 ;
|
||||||
|
listen [::]:80 ;
|
||||||
test
|
return 404;
|
||||||
|
}
|
||||||
|
```
|
||||||
Loading…
Reference in new issue