Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
test-results
node_modules

# Output
.output
.vercel
.netlify
.wrangler
.svelte-kit
build

# OS
.DS_Store
Thumbs.db

# Env
.env
.env.*
!.env.example
!.env.test

# Vite
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Package Managers
package-lock.json
pnpm-lock.yaml
yarn.lock
bun.lock
bun.lockb

# Miscellaneous
/static/
19 changes: 19 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"useTabs": true,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"plugins": [
"prettier-plugin-svelte",
"prettier-plugin-tailwindcss"
],
"overrides": [
{
"files": "*.svelte",
"options": {
"parser": "svelte"
}
}
],
"tailwindStylesheet": "./src/app.css"
}
22 changes: 0 additions & 22 deletions HOW-TO-START.md

This file was deleted.

41 changes: 26 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,39 @@
# The Mapping Project (TMP)
# sv

## Introduction
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).

TMP is an open source project that will result in the creation of an application (web/mobile) that provides a robust, interactive experience with local organizations and events. It intends to facilitate community and economic growth through serving several different audiences: the local community, tourists, local businesses and organizations, and new and experienced developers.
## Creating a project

The initial target for this project is the Augusta, GA downtown. After that we want to expand it to include the rest of Augusta proper as well as surrounding communities. From there we hope the project will continue to be implemented in communities throughout the world.
If you're seeing this, you've probably already done this step. Congrats!

### The Local Community
```sh
# create a new project in the current directory
npx sv create

TMP will help locals in the community to explore all that the locale has to offer from events to organizations and businesses.
# create a new project in my-app
npx sv create my-app
```

### Tourists
## Developing

TMP will help tourists learn about our community and spend their time in an enjoyable manner by taking advantage of the unique (and often lesser-known) opportunities the locale offers.
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

### Local Businesses and Organizations
```sh
npm run dev

TMP will help local businesses and organizations increase brand name awareness, share information about their events, and offer networking opportunities.
# or start the server and open the app in a new browser tab
npm run dev -- --open
```

### New and Experienced Developers
## Building

#### New Developers
To create a production version of your app:

We believe that being able to demonstrate real-world application code allows developers to get a step ahead in a competitive job market.
```sh
npm run build
```

TMP can facilitate this in a few ways:
You can preview the production build with `npm run preview`.

1. This is a real-world project that is open source and thus the resultant code is publicly accessible with an auditable history that can be used to demonstrate individual experience and skills.
2. Experienced developers are contributing to the project and eager to assist newer developers in becoming productive and creating real-world code.
Expand All @@ -47,4 +56,6 @@ Check out [How to Start](devDocs/HOW-TO-START.md) and [The Next Step](devDocs/TH

## License

The software is licensed under the [MIT license](license.md).
The software is licensed under the [MIT license](license.md).

> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
18 changes: 0 additions & 18 deletions THE-NEXT-STEP.md

This file was deleted.

6 changes: 6 additions & 0 deletions e2e/demo.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { expect, test } from '@playwright/test';

test('home page has expected h1', async ({ page }) => {
await page.goto('/');
await expect(page.locator('h1')).toBeVisible();
});
43 changes: 43 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import prettier from 'eslint-config-prettier';
import { fileURLToPath } from 'node:url';
import { includeIgnoreFile } from '@eslint/compat';
import js from '@eslint/js';
import svelte from 'eslint-plugin-svelte';
import { defineConfig } from 'eslint/config';
import globals from 'globals';
import ts from 'typescript-eslint';
import svelteConfig from './svelte.config.js';

const gitignorePath = fileURLToPath(new URL('./.gitignore', import.meta.url));

export default defineConfig(
includeIgnoreFile(gitignorePath),
js.configs.recommended,
...ts.configs.recommended,
...svelte.configs.recommended,
prettier,
...svelte.configs.prettier,
{
languageOptions: {
globals: { ...globals.browser, ...globals.node }
},
rules: { // typescript-eslint strongly recommend that you do not use the no-undef lint rule on TypeScript projects.
// see: https://typescript-eslint.io/troubleshooting/faqs/eslint/#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
"no-undef": 'off' }
},
{
files: [
'**/*.svelte',
'**/*.svelte.ts',
'**/*.svelte.js'
],
languageOptions: {
parserOptions: {
projectService: true,
extraFileExtensions: ['.svelte'],
parser: ts.parser,
svelteConfig
}
}
}
);
Loading