Merge pull request #7 from wikimediabrasil/one-repo-to-rule-them-all

One repo to rule them all

Author: arcstur

.github/workflows/toolforge-deploy.yml

@@ -0,0 +1,39 @@
+name: Toolforge Deploy
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  deploy:
+    name: Deploy to Toolforge
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Configure SSH key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          known_hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
+
+      - name: Run deployment commands
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ vars.SSH_HOST }}
+          username: ${{ secrets.SSH_USER }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          port: ${{ vars.SSH_PORT }}
+          request_pty: true
+          script: |
+            set -xe
+            become infographics git -C ./www/python/src pull origin main
+            become infographics webservice node18 shell -- npm --prefix ./www/python/client/ install
+            become infographics webservice --mem 1Gi node18 shell -- npm --prefix ./www/python/client/ run build
+            become infographics mkdir -p ./www/python/src/web/templates
+            become infographics mkdir -p ./www/python/src/web/static/frontend
+            become infographics cp ./www/python/client/dist/index.html ./www/python/src/web/templates/index.html
+            become infographics cp -r ./www/python/client/dist/assets ./www/python/src/web/static/frontend/assets
+            become infographics webservice python3.11 shell -- webservice-python-bootstrap
+            become infographics webservice python3.11 shell -- ./www/python/venv/bin/python ./www/python/src/manage.py migrate
+            become infographics webservice python3.11 shell -- ./www/python/venv/bin/python ./www/python/src/manage.py collectstatic --noinput
+            become infographics webservice python3.11 restart
+            become infographics webservice python3.11 status

.gitignore

@@ -1,13 +1,18 @@
-# Created by https://www.toptal.com/developers/gitignore/api/react
-# Edit at https://www.toptal.com/developers/gitignore?templates=react
+# Django collected static files
+/src/static
+
+# Static files and templates from frontend code
+/src/web/static/frontend
+/src/web/templates/index.html
 
-### react ###
 .DS_*
 *.log
 logs
 **/*.backup.*
 **/*.back.*
 /.idea
+/dist
+/client/dist
 
 node_modules
 bower_components
@@ -19,4 +24,14 @@ thumb
 sketch
 .env
 
-# End of https://www.toptal.com/developers/gitignore/api/react
+
+.idea
+__pycache__
+*/__pycache__
+config.yaml
+Lib/
+Scripts/
+.venv/
+venv/
+*.db
+*.sqlite3

Dockerfile

@@ -0,0 +1,26 @@
+FROM docker-registry.tools.wmflabs.org/toolforge-node18-sssd-web:latest AS frontend
+
+COPY client /client
+WORKDIR /client
+
+RUN npm install
+RUN npm run build
+
+FROM docker-registry.tools.wmflabs.org/toolforge-python311-sssd-web:latest AS runner
+
+WORKDIR /root/www/python/
+
+COPY src/requirements.txt ./src/requirements.txt
+RUN webservice-python-bootstrap
+
+COPY src ./src
+WORKDIR /root/www/python/src/
+
+COPY --from=frontend /client/dist/index.html ./web/templates/index.html
+COPY --from=frontend /client/dist/assets ./web/static/frontend/assets
+
+EXPOSE 7840
+CMD ["/bin/bash", "-c", "source ../venv/bin/activate && \
+  python3 manage.py collectstatic --no-input && \
+  python3 manage.py migrate && \
+  python3 manage.py runserver 0.0.0.0:7840"]

README.md

@@ -1,79 +1,20 @@
 # Wiki Infographics
 
-Wiki Infographics is a platform to leverage structured information within Wikimedia projects to create informative and visually engaging infographics in both fixed and dynamic formats, under an open license. It is available at https://infographics.toolforge.org.
+Wiki Infographics is a platform to leverage structured information within Wikimedia projects to create informative and visually engaging infographics in both fixed and dynamic formats, under an open license. It is available at <https://infographics.toolforge.org>.
 
-The backend codebase is available in this repository [wiki_infographics-backend](https://github.com/WikiMovimentoBrasil/wiki_infographics-backend)
+The tool is composed of a Django backend and a React frontend, both on this repository.
 
-## Table of Contents
+## Running locally
 
-- [Getting Started](#getting-started)
-  - [Prerequisites](#prerequisites)
-  - [Installation](#installation)
-- [Contributing](#contributing)
-- [License](#license)
+To run the tool locally, you need Docker and Docker Compose.
 
-## Getting started:
-
-### Prerequisites
-
-Before you begin, ensure you have met the following requirements:
-
-- Nodejs >= v18.16.0
-
-### Installation
-
-1. Clone the repository
-
-   ```bash
-   git clone https://github.com/WikiMovimentoBrasil/wiki_infographics.git
-
-   ```
-
-2. Navigate to the project directory:
-
-   ```bash
-   cd wiki_infographics
-
-   ```
-
-3. Install project dependencies:
-
-   ```bash
-   npm install
-
-   ```
-
-4. Start the development server:
-   ```bash
-    npm run dev
-   ```
-
-You should now be able to access the project at http://localhost:5173 in your web browser
-
-To connect backend with this frontend go to this repository
-[wiki_infographics-backend](https://github.com/WikiMovimentoBrasil/wiki_infographics-backend)
-
-## Running in toolforge
-
-### Rebuild the image (after a code change)
-```
-> ssh login.toolforge.org
-> toolforge~# become <yourtool>
-> yourtool@toolforge~# toolforge build start <url_for_this_repo>
-> yourtool@toolforge~# toolforge webservice buildservice restart
+```bash
+docker-compose up --build
 ```
 
-More info on buildservice (debugging, etc.) [here](https://wikitech.wikimedia.org/wiki/Help:Toolforge/Build_Service)
-
-## Contributing
-
-Contributions are welcome! To contribute to Wiki Infographics, follow these steps:
+Open the app at <https://localhost:7840>.
 
-1. Fork the repository
-2. Create a new branch: git checkout -b feature/your-feature
-3. Make your changes and commit them: git commit -m 'Add some feature'
-4. Push to the branch: git push origin feature/your-feature
-5. Create a pull request on GitHub
+If you make any changes, you can kill the process and run again, or restart the app container with `docker-compose up -d --build --force-recreate app`.
 
 ## Todos