Update README.md: Remove Lovable generated doc and make own doc
This commit is contained in:
parent
d6c6542ad1
commit
467fc821e9
1 changed files with 7 additions and 67 deletions
74
README.md
74
README.md
|
|
@ -1,73 +1,13 @@
|
||||||
# Welcome to your Lovable project
|
# New Website!
|
||||||
|
|
||||||
## Project info
|
## How to deploy?
|
||||||
|
|
||||||
**URL**: https://lovable.dev/projects/REPLACE_WITH_PROJECT_ID
|
You should install ``pnpm``.
|
||||||
|
|
||||||
## How can I edit this code?
|
Initialize the project with ``pnpm i``.
|
||||||
|
|
||||||
There are several ways of editing your application.
|
And then you can easily run a developer server using ``pnpm run start``.
|
||||||
|
|
||||||
**Use Lovable**
|
If for any reason you would like to submit patches, complain or just chatter, check out [my new contact me page](https://damaj.tech/whoami).
|
||||||
|
|
||||||
Simply visit the [Lovable Project](https://lovable.dev/projects/REPLACE_WITH_PROJECT_ID) and start prompting.
|
Currently only accepting patches!
|
||||||
|
|
||||||
Changes made via Lovable will be committed automatically to this repo.
|
|
||||||
|
|
||||||
**Use your preferred IDE**
|
|
||||||
|
|
||||||
If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.
|
|
||||||
|
|
||||||
The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
|
|
||||||
|
|
||||||
Follow these steps:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# Step 1: Clone the repository using the project's Git URL.
|
|
||||||
git clone <YOUR_GIT_URL>
|
|
||||||
|
|
||||||
# Step 2: Navigate to the project directory.
|
|
||||||
cd <YOUR_PROJECT_NAME>
|
|
||||||
|
|
||||||
# Step 3: Install the necessary dependencies.
|
|
||||||
npm i
|
|
||||||
|
|
||||||
# Step 4: Start the development server with auto-reloading and an instant preview.
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
**Edit a file directly in GitHub**
|
|
||||||
|
|
||||||
- Navigate to the desired file(s).
|
|
||||||
- Click the "Edit" button (pencil icon) at the top right of the file view.
|
|
||||||
- Make your changes and commit the changes.
|
|
||||||
|
|
||||||
**Use GitHub Codespaces**
|
|
||||||
|
|
||||||
- Navigate to the main page of your repository.
|
|
||||||
- Click on the "Code" button (green button) near the top right.
|
|
||||||
- Select the "Codespaces" tab.
|
|
||||||
- Click on "New codespace" to launch a new Codespace environment.
|
|
||||||
- Edit files directly within the Codespace and commit and push your changes once you're done.
|
|
||||||
|
|
||||||
## What technologies are used for this project?
|
|
||||||
|
|
||||||
This project is built with:
|
|
||||||
|
|
||||||
- Vite
|
|
||||||
- TypeScript
|
|
||||||
- React
|
|
||||||
- shadcn-ui
|
|
||||||
- Tailwind CSS
|
|
||||||
|
|
||||||
## How can I deploy this project?
|
|
||||||
|
|
||||||
Simply open [Lovable](https://lovable.dev/projects/REPLACE_WITH_PROJECT_ID) and click on Share -> Publish.
|
|
||||||
|
|
||||||
## Can I connect a custom domain to my Lovable project?
|
|
||||||
|
|
||||||
Yes, you can!
|
|
||||||
|
|
||||||
To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.
|
|
||||||
|
|
||||||
Read more here: [Setting up a custom domain](https://docs.lovable.dev/features/custom-domain#custom-domain)
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue