https://github.com/iwalton3/swapi-svelte

An swapi client written in Svelte.
https://github.com/iwalton3/swapi-svelte

svelte

Last synced: 3 days ago
JSON representation

An swapi client written in Svelte.

• Host: GitHub
• URL: https://github.com/iwalton3/swapi-svelte
• Owner: iwalton3
• License: mit
• Created: 2019-08-24T21:14:42.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:58:41.000Z (almost 2 years ago)
• Last Synced: 2023-03-05T17:54:58.733Z (over 1 year ago)
• Topics: svelte
• Language: JavaScript
• Size: 646 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Swapi-Svelte

This is a client for swapi written in Svelte. It uses a custom router intended for routing multiple relatively self-contained applications.

For those who are unaware of Svelte, It is easy to learn web framework, packed with features. It builds some of the most compact and performant single page web applications.

To build the project, you'll need an swapi server. Download the `api.js` from your server by appending `.js` to the end of your API url. Run `npm install` to download the build dependencies. Then use `npm run build` to build. For development, use `npm run dev`.

## Using as a template with any backend.

The swapi system is the optional backend, which was written first. It provides the user and session management for this front-end. If desired, it is possible to write a new back-end instead of using swapi, as this svelte template has a lot of features that may be desired in other projects. Please see the contents of `api.js` for information on what API functionality is expected by the authorization and user management system provided by this template.

## HTML5 Routing

The template uses hash routing (`/#/`) by default for easier deployment. If you wish to use HTML5 routing, simply set a base href in the document and the router will automatically switch to using real paths and redirect all hash routes to real paths.

Note that HTML5 routing requires a configuration on your server. For apache, you can use the following `.htaccess` or directory configuration:

```

RewriteEngine on

RewriteCond %{REQUEST_FILENAME} -s [OR]

RewriteCond %{REQUEST_FILENAME} -l [OR]

RewriteCond %{REQUEST_FILENAME} -d

RewriteRule ^.*$ - [NC,L]

RewriteRule ^(.*) index.html [NC,L]

```

For nginx, use try\_files:

```

try_files $uri $uri/ /index.html;

```

## SCSS and TypeScript Support

You can use scss files by including them from main.js globally or by using `lang="scss"` in a svelte component. There is also partial TypeScript support in the build configuration, but please note this is not fully supported and may create long build times. Visual Studio Code integration with scss is supported.  Additional processors may be installed, please see: https://github.com/kaisermann/svelte-preprocess

## IE 11 Support

This repository also implements IE 11 polyfills. The polyfills are not loaded on modern browsers.