https://github.com/inkollusireeshaadharani/vue-starter-kit
https://github.com/inkollusireeshaadharani/vue-starter-kit
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/inkollusireeshaadharani/vue-starter-kit
- Owner: inkollusireeshaadharani
- Created: 2023-10-14T14:18:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-14T16:52:48.000Z (over 1 year ago)
- Last Synced: 2024-11-08T19:43:15.232Z (7 months ago)
- Language: JavaScript
- Size: 99.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-surreal - SurrealDB + Vue Starter - Dharani Inkollu. (Starter Kits)
README
# vue-starter-application
This SurrealDB Starter Kit for Vue.js is a simple task manager application that allows you to manage tasks using SurrealDB as the database backend. The starter kit should help you get started with building applications using Vue.js and SurrealDB.
## Features
- Create, read, and delete tasks in a SurrealDB table.
- Error handling for database interactions.
- Parameterized queries to prevent SQL injection.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Node.js: Make sure you have Node.js installed on your system. You can download it from [here](https://nodejs.org/en/download/).
## Developing using the starter kit
1. Clone this repository
```sh
git clone https://github.com/inkollusireeshaadharani/vue-starter-kit.git
```
1. Navigate to the project directory
```sh
cd vue-starter-kit
```
1. Install Dependencies
```sh
npm install
```
1. Configure SurrealDB connection: Open the **src/db/surreal.js** file and configure the connection settings for SurrealDB. You may need to update the database URL and credentials.
1. Get SurrealDB up and running using Docker
```sh
docker compose up -d
```
> Note: You can also install SurrealDB on your machine. For more information, check out [SurrealDB installation](https://surrealdb.com/install).
1. Run the project in development mode
```sh
npm run dev
```
1. Access the application in your web browser at http://localhost:5173.
1. Do not forget to shut down SurrealDB when you are done.
```sh
docker compose down
```
## Usage
- Create a task: Enter a task name along with its status and click the **Add Task** button.
- Delete a task: Click the **Delete** button next to the task you want to delete.
- View the list of tasks: All the tasks are available under the **List of Tasks** section.
## Screenshot
## Contributing to this repository
If you have any questions or suggestions, please feel free to open an issue or a pull request.
Learn more about SurrealDB here: https://surrealdb.com