From e860465ec49ff0b25f5879c53432377843723994 Mon Sep 17 00:00:00 2001 From: s-prechtl Date: Tue, 20 Sep 2022 10:58:25 +0200 Subject: [PATCH] README.md changed to explain docker commands --- backend/strapi/README.md | 56 +-------------------------------------- frontend/svelte/README.md | 39 ++++----------------------- 2 files changed, 6 insertions(+), 89 deletions(-) diff --git a/backend/strapi/README.md b/backend/strapi/README.md index 8616543..5b27ac3 100644 --- a/backend/strapi/README.md +++ b/backend/strapi/README.md @@ -1,57 +1,3 @@ # 🚀 Getting started with Strapi -Strapi comes with a full featured [Command Line Interface](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html) (CLI) which lets you scaffold and manage your project in seconds. - -### `develop` - -Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-develop) - -``` -npm run develop -# or -yarn develop -``` - -### `start` - -Start your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-start) - -``` -npm run start -# or -yarn start -``` - -### `build` - -Build your admin panel. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-build) - -``` -npm run build -# or -yarn build -``` - -## ⚙️ Deployment - -Strapi gives you many possible deployment options for your project. Find the one that suits you on the [deployment section of the documentation](https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/deployment.html). - -## 📚 Learn more - -- [Resource center](https://strapi.io/resource-center) - Strapi resource center. -- [Strapi documentation](https://docs.strapi.io) - Official Strapi documentation. -- [Strapi tutorials](https://strapi.io/tutorials) - List of tutorials made by the core team and the community. -- [Strapi blog](https://docs.strapi.io) - Official Strapi blog containing articles made by the Strapi team and the community. -- [Changelog](https://strapi.io/changelog) - Find out about the Strapi product updates, new features and general improvements. - -Feel free to check out the [Strapi GitHub repository](https://github.com/strapi/strapi). Your feedback and contributions are welcome! - -## ✨ Community - -- [Discord](https://discord.strapi.io) - Come chat with the Strapi community including the core team. -- [Forum](https://forum.strapi.io/) - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members. -- [Awesome Strapi](https://github.com/strapi/awesome-strapi) - A curated list of awesome things related to Strapi. - ---- - -🤫 Psst! [Strapi is hiring](https://strapi.io/careers). +Starting the container: ``docker-compose up`` diff --git a/frontend/svelte/README.md b/frontend/svelte/README.md index 5c91169..4f36e87 100644 --- a/frontend/svelte/README.md +++ b/frontend/svelte/README.md @@ -1,38 +1,9 @@ -# create-svelte +# Creating the svelte project -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +## Create the docker image -## Creating a project +``docker build -t svelte .`` -If you're seeing this, you've probably already done this step. Congrats! +## Run the docker container -```bash -# create a new project in the current directory -npm create svelte@latest - -# create a new project in my-app -npm create svelte@latest my-app -``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```bash -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` - -## Building - -To create a production version of your app: - -```bash -npm run build -``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +``docker run --name svelte -dp 5173:5173 svelte`` \ No newline at end of file